mshirmohammadi / api.ir
PHP SDK for api.ir services
Requires
- php: >=5.6
- ext-curl: *
README
با استفاده از این پکیج میتوانید استعلامات زیر را در کسری از ثانیه دریافت نمایید.
📦 نصب
کافی است با استفاده از کامپوزر دستور زیر را اجرا نمایید.
composer require mshirmohammadi/api.ir
📦 راه اندازی
require 'vendor/autoload.php'; use Shirmohammadi\Api_Services\Api_Services; $token = "YOUR_API_TOKEN"; $api = new Api_Services($token);
⚡ متدها
1- احراز هویت شاهکار اشخاص حقیقی و حقوقی (Shahkar)
توضیح: وب سرویس شاهکار تطبیق کد ملی با شماره موبایل را استعلام می نماید. در این نسخه دیتا به صورت رمز شده استعلام می گردد. همچنین امکان استعلام شناسه ملی و سیم کارت اشخاص حقوقی هم دارد
پارامترها:
nationalCode(string) – کد ملی فرد یا شناسه ملی شرکتmobile(string) – شماره موبایلisCompany(bool, اختیاری) – true برای شرکت، false برای فرد (پیشفرض: false)
نمونه استفاده:
$nationalCode = "11111111111"; $mobile = "09120000000"; $result = $api->Shahkar($nationalCode, $mobile,true); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
2- احراز هویت شاهکار Lite (ShahkarLite)
توضیح:: نسخه Lite وب سرویس شاهکار تطبیق کد ملی با شماره موبایل را استعلام می کند. دیتا به صورت رمز شده نیست و هزینه پایینتری دارد.
پارامترها:
nationalCode (string) – کد ملی
mobile (string) – شماره موبایل
نمونه استفاده:
$nationalCode = "0010007700"; $mobile = "09120000000"; $result = $api->ShahkarLite($nationalCode, $mobile); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
3- استعلام عکس هویتی (PersonImage)
توضیح: این وب سرویس با دریافت کد ملی و تاریخ تولد عکس کارت ملی را از ثبت احوال استعلام می نماید. ارائه این سرویس به شرکت ها و سازمان ها با ارائه مجوز مقدور است.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
serialNumber (string) – سریال پشت کارت ملی یا رهیگیری رسید کارت ملی
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $serialNumber = "i1R8389398"; $result = $api->PersonImage($nationalCode, $birthDate, $serialNumber); print_r($result);
نمونه پاسخ:
{
"data": {
"imageBase64": "iVBORw0KGgoAAAANSUhEUgAA..."
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
4- تطبیق کد ملی با کارت بانکی (CardMatch)
توضیح: با وب سرویس تطبیق کد ملی با کارت بانکی می توانید از دریافت صحیح کارت ملی متعلق به مشتری مطمئن شوید.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
cardNumber (string) – شماره کارت بانکی
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $cardNumber = "6037990000000000"; $result = $api->CardMatch($nationalCode, $birthDate, $cardNumber); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
5- تطبیق کد ملی با شبا (IbanMatch)
توضیح: با وب سرویس استعلام تطبیق کد ملی با شبا می توانید مطمئن شوید که شبا دریافتی متعلق به کد ملی مشتری باشد.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
iban (string) – شماره شبا 26 رقمی به فرمت IR000000000000000000000000
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $iban = "IR820540102680020817909002"; $result = $api->IbanMatch($nationalCode, $birthDate, $iban); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
6- تطبیق کد ملی با شبا پرو (IbanMatchPro)
توضیح: سرویس تطبیق شماره شبا و کد ملی بدون تاریخ تولد امکان اعتبارسنجی مالک حساب بانکی را بهصورت سریع و امن برای کسبوکارها فراهم میکند. این API با دریافت شماره شبا و کد ملی، تطابق یا عدم تطابق اطلاعات را بهصورت شفاف در خروجی اعلام میکند.
پارامترها:
nationalCode (string) – کد ملی
iban (string) – شماره شبا 26 رقمی به فرمت IR000000000000000000000000
نمونه استفاده:
$nationalCode = "0010007700"; $iban = "IR820540102680020817909002"; $result = $api->IbanMatchPro($nationalCode, $iban); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
7- وب سرویس تماس تلفنی (makeCall)
توضیح: این وب سرویس برای برقراری تماس با مشتری است. با این وب سرویس می توانید پیام های طولانی را از طریق تماس به مشتری اعلام کنید. تماس تلفنی بلک لیست ندارد. به تمامی شماره های ثابت و همراه قابل ارسال است. امکان سفارشی سازی لهجه و گویش و موزیک پس زمینه را دارد.
پارامترها:
numbers (array) – لیستی از شماره موبایل ها یا تلفن های ثابت
voiceID (string) – شناسه فایل صوتی
نمونه استفاده:
$voiceID = "397FB7F7-38A5-4748-A72B-352FF36B0D71"; $numbers = ["09120000000", "02112345678"]; $result = $api->makeCall($numbers, $voiceID); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
8- وب سرویس OTP تلفنی (CallOTP)
توضیح: نرخ ارسال پیامک با خط خدماتی از بهترین شبکه پیامکی کمتر 95% است. برای همین شرکت هایی مثل دیجیکالا و بانی مد ارسال کد تلفنی را به عنوان پشتیبان پیامک پیاده سازی کردند. بنابراین شما هم برای اینکه هیچ مشتری از دست ندهید می توانید این سرویس را به عنوان پشتیبان ارسال کد های پیامکی پیاده سازی کنید.
پارامترها:
code (string) – کد یکبار مصرف یا OTP
number (string) – شماره موبایل 09121112222 یا تلفن ثابت به فرمت 02122228888
نمونه استفاده:
$code = "12345"; $number = "09121112222"; $result = $api->CallOTP($code, $number); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
9- وب سرویس OTP تلفنی alt (CallOTPalt)
توضیح: تماس با قابلیت هایی که دارد به عنوان گزینه پشتیبان برای پیامک نیز می باشد. سرویس CallOTPalt با شبکه مجزا به عنوان گزینه پشتیبان سرویس CallOTP می باشد.
پارامترها:
code (string) – کد یکبار مصرف یا OTP
number (string) – شماره موبایل 09121112222 یا تلفن ثابت به فرمت 02122228888
نمونه استفاده:
$code = "1234"; $number = "09121112222"; $result = $api->CallOTPalt($code, $number); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
10- وب سرویس OTP پیامکی (SmsOTP)
توضیح: برای ارسال کد یا رمز پیامکی به تمامی شماره ها دیگه به خط خدماتی یا خرید پنل پیامکی نیازی ندارید. کدهای شما از بهترین و سریع ترین شبکه پیامکی با خط 8 رقمی رند به تمامی شماره ها ارسال می شود.
پارامترها:
code (string) – کد یا OTP
mobile (string) – موبایل به فرمت 09121112222
template (int, اختیاری) – کد=0 کد ورود=1 کد تایید=2 رمز=3 رمز ورود=4 (پیشفرض: 1)
نمونه استفاده:
$code = "123456"; $mobile = "09120000000"; $template = 1; $result = $api->SmsOTP($code, $mobile, $template); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
11- ارسال پیامک خدماتی (SendSms)
توضیح: این وب سرویس برای ارسال انواع پیامک به تمامی شماره ها با خط اختصاصی و خدماتی می باشد.
پارامترها:
message (string) – متن پیامک
mobiles (array) – موبایل ها به صورت لیست
نمونه استفاده:
$message = "کاربر گرامی بسته شما با شماره 1828772 به پست ارسال شد"; $mobiles = ["09120001111", "09120002222"]; $result = $api->SendSms($message, $mobiles); print_r($result);
نمونه پاسخ:
{
"data": 1,
"success": true,
"code": 1,
"error": null,
"message": null
}
12- احراز ویدئویی بایومتریک (VideoMatch)
توضیح: احراز هویت بایومتریک، یا احراز هویت ویدئویی نوعی احراز هویت است که فیلم کوتاه از چهره فرد گرفته شده و با اطلاعات هویتی و تصویر کارت ملی وی مقایسه می گردد و در نهایت تطبیق آنها اعلام می شود.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
serialNumber (string) – سریال پشت کارت ملی یا رهیگیری رسید کارت ملی
videoBase64 (string) – ویدئوی سلفی کاربر به صورت بیس64 و حداکثر 5مگابایت
matchingThreshold (int, اختیاری) – حد آستانه تطبیق چهره (پیشفرض: 90)
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $serialNumber = "i1R8389398"; $videoBase64 = "iVBORw0KGgoAAAANSUhEUgAA..."; $matchingThreshold = 90; $result = $api->VideoMatch($nationalCode, $birthDate, $serialNumber, $videoBase64, $matchingThreshold); print_r($result);
نمونه پاسخ:
{
"data": {
"matchingScore": 92,
"isMatch": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
13- احراز ویدئویی بایومتریک لایو (VideoLive)
توضیح: احراز هویت بایومتریک Live، نوعی احراز بایومتریک ویدئویی است که فیلم کوتاه از چهره فرد گرفته شده و با اطلاعات هویتی و تصویر کارت ملی وی مقایسه می گردد و در نهایت تطبیق آنها اعلام می شود و زنده سنجی کاربر را انجام می دهد و از تکنیک های ضد تقلب در این احراز هویت استفاده می شود.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
serialNumber (string) – سریال پشت کارت ملی یا رهیگیری رسید کارت ملی
videoBase64 (string) – ویدئوی سلفی کاربر به صورت بیس64 و حداکثر 5مگابایت
matchingThreshold (int, اختیاری) – حد آستانه تطبیق چهره (پیشفرض: 90)
livenessThreshold (int, اختیاری) – حد آستانه زنده سنجی (پیشفرض: 80)
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $serialNumber = "i1R8389398"; $videoBase64 = "iVBORw0KGgoAAAANSUhEUgAA..."; $matchingThreshold = 90; $livenessThreshold = 80; $result = $api->VideoLive($nationalCode, $birthDate, $serialNumber, $videoBase64, $matchingThreshold, $livenessThreshold); print_r($result);
نمونه پاسخ:
{
"data": {
"matchingScore": 91,
"livenessScore": 85,
"isMatch": true,
"isLiveness": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
14- احراز ویدئویی بایومتریک جامع (VideoVerify)
توضیح: احراز هویت بایومتریک +Live، نوعی احراز بایومتریک ویدئویی است که فیلم کوتاه از چهره فرد گرفته شده و با اطلاعات هویتی و تصویر کارت ملی وی مقایسه می گردد و در نهایت تطبیق آنها اعلام می شود و زنده سنجی کاربر را انجام می دهد + امکان خواندن متنی به جهت آگاهی کاربر و اعلام کاربر را دارد.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
serialNumber (string) – سریال پشت کارت ملی یا رهیگیری رسید کارت ملی
videoBase64 (string) – ویدئوی سلفی کاربر به صورت بیس64 و حداکثر 5مگابایت
speechText (string) – متنی که فرد در زمان ضبط می خواند
matchingThreshold (int, اختیاری) – حد آستانه تطبیق چهره (پیشفرض: 90)
livenessThreshold (int, اختیاری) – حد آستانه زنده سنجی (پیشفرض: 80)
speechThreshold (int, اختیاری) – حد آستانه تطبیق گفتار (پیشفرض: 50)
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $serialNumber = "i1R8389398"; $videoBase64 = "iVBORw0KGgoAAAANSUhEUgAA..."; $speechText = "من در سایت ... با آگاهی کامل از شرایط قوانین سایت را می پذیرم"; $matchingThreshold = 90; $livenessThreshold = 80; $speechThreshold = 50; $result = $api->VideoVerify($nationalCode, $birthDate, $serialNumber, $videoBase64, $speechText, $matchingThreshold, $livenessThreshold, $speechThreshold); print_r($result);
نمونه پاسخ:
{
"data": {
"matchingScore": 95,
"isMatch": true,
"livenessScore": 85,
"isLiveness": true,
"speechScore": 55,
"isSpeechMatched": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
15- احراز تصویری بایومتریک (FaceMatch)
توضیح: احراز هویت تصویری بایومتریک، نوعی احراز بایومتریک است که عکس سلفی کاربر یا یک فریم از ویدئو سلفی با تصویر استعلامی از ثبت احوال بررسی و مقایسه می گردد و در نهایت تطبیق آنها اعلام می شود.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
serialNumber (string) – سریال پشت کارت ملی یا رهیگیری رسید کارت ملی
imageBase64 (string) – عکس سلفی به فرمت بیس 64
matchingThreshold (int, اختیاری) – آستانه تطبیق بین 50 تا 100 عدد (پیشفرض: 75)
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $serialNumber = "i1R8389398"; $imageBase64 = "iVBORw0KGgoAAAANSUhEUgAA..."; $matchingThreshold = 75; $result = $api->FaceMatch($nationalCode, $birthDate, $serialNumber, $imageBase64, $matchingThreshold); print_r($result);
نمونه پاسخ:
{
"data": {
"matchingScore": 75,
"isMatch": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
16- احراز تصویری بایومتریک Lite (FaceMatchLite)
توضیح: احراز هویت تصویری بایومتریک، نوعی احراز بایومتریک است که عکس سلفی کاربر یا یک فریم عکس از ویدئو احراز هویت با تصویر کارت ملی استعلامی از ثبت احوال وی مقایسه می گردد. نسخه lite با نسخه اصلی فرق آن در تفاوت هوش مصنوعی پردازش گر تصویر است.
پارامترها:
nationalCode (string) – کد ملی
birthDate (string) – تاریخ تولد به فرمت : 1370/1/1
serialNumber (string) – سریال پشت کارت ملی یا رهگیری رسید کارت ملی
imageBase64 (string) – عکس سلفی به فرمت بیس 64
matchingThreshold (int, اختیاری) – آستانه تطبیق بین 50 تا 100 عدد (پیشفرض: 75)
نمونه استفاده:
$nationalCode = "0010007700"; $birthDate = "1371/1/1"; $serialNumber = "i1R8389398"; $imageBase64 = "iVBORw0KGgoAAAANSUhEUgAA..."; $matchingThreshold = 75; $result = $api->FaceMatchLite($nationalCode, $birthDate, $serialNumber, $imageBase64, $matchingThreshold); print_r($result);
نمونه پاسخ:
{
"data": {
"matchingScore": 75,
"isMatch": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
17- استعلام دارنده اینماد (Enamad)
توضیح: با این وب سرویس می توانید وضعیت نماد اعتماد یک وب سایت را استعلام کنید.
پارامترها:
domain (string) – نام دامنه
نمونه استفاده:
$domain = "simano.ir"; $result = $api->Enamad($domain); print_r($result);
نمونه پاسخ:
{
"data": {
"domain": "string",
"title": "string",
"province": "string",
"city": "string",
"star": 1,
"addDate": "string",
"expDate": "string"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
18- وب سرویس بگراند پویا برنامه (Wallpaper)
توضیح: این وب سرویس به صورت روزانه تصاویر بک گراند جدیدی از سراسر جهان به شما نمایش می دهد که می تواند محیط نرم افزار و سایت شما را جذاب کند.
پارامترها: بدون پارامتر
نمونه استفاده:
$result = $api->Wallpaper(); print_r($result);
نمونه پاسخ:
{
"data": null,
"success": true,
"code": 1,
"error": null,
"message": null
}
19- استعلام شبا با شماره حساب (BankAccountInfo)
توضیح: این وب سرویس شماره حساب بانکی را استعلام کرده و شماره شبا را متعلق به آن حساب را ارائه می دهد.
پارامترها:
accountNumber (string) – شماره حساب بانکی
bankCode (string) – کد بانک (مرکزی=010، ملت=012، ملی=017، تجارت=018 و ...)
نمونه استفاده:
$accountNumber = "3022.100.18878774.1"; $bankCode = "012"; $result = $api->BankAccountInfo($accountNumber, $bankCode); print_r($result);
نمونه پاسخ:
{
"data": {
"iban": "IR820540102680020817909002",
"active": true,
"owners": [
"مالک ۱",
"مالک ۲"
],
"bankName": "ملت"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
20- استعلام مشخصات کارت بانکی (BankCardInfo)
توضیح: با این وب سرویس می توانید از طریق شماره کارت، نام دارنده کارت + شماره شبا + شماره حساب را استعلام نمایید.
پارامترها:
cardNumber (string) – شماره کارت
نمونه استفاده:
$cardNumber = "6037990000000000"; $result = $api->BankCardInfo($cardNumber); print_r($result);
نمونه پاسخ:
{
"data": {
"name": "امیر تبریزی",
"iban": "IR820540102680020817909002",
"accountNumber": "122.344.1234567890.1"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
21- سرویس تبدیل کارت به شبا (CardToIban)
توضیح: با این وب سرویس می توانید مشخصات شبا یک کارت بانکی را دریافت نمایید.
پارامترها:
cardNumber (string) – شماره کارت بانکی
نمونه استفاده:
$cardNumber = "6037990000000000"; $result = $api->CardToIban($cardNumber); print_r($result);
نمونه پاسخ:
{
"data": {
"name": "علی رضایی",
"iban": "IR820540102680020817909002",
"bankName": "بانک ملت"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
22- استعلام نام دارنده شبا (IbanInfo)
توضیح: با این وب سرویس می توانید نام شخص و نام بانک و وضعیت فعال بودن شبا بانکی را استعلام نمایید.
پارامترها:
iban (string) – شماره شبا 26 رقمی به فرمت IR000000000000000000000000
نمونه استفاده:
$iban = "IR820540102680020817909002"; $result = $api->IbanInfo($iban); print_r($result);
نمونه پاسخ:
{
"data": {
"name": "علی رضایی",
"bankName": "بانک ملت",
"active": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
23- استعلام شخص حقوقی (CompanyInfo)
توضیح: این وب سرویس با دریافت شناسه ملی، اطلاعات ثبتی آن شخص حقوقی (شرکت یا موسسه یا سازمان) را استعلام می نماید. این سرویس برای اعتبار سنجی و استعلام دقیق مشخصات شخص حقوقی کاربرد دارد.
پارامترها:
nationalID (string) – شناسه ملی شرکت
نمونه استفاده:
$nationalID = "14007650912"; $result = $api->CompanyInfo($nationalID); print_r($result);
نمونه پاسخ:
{
"data": {
"companyType": "شركت سهامي خاص",
"name": "شرکت نمونه",
"nationalID": 14000567890,
"registerNumber": 12345,
"registerDate": "1400/01/01",
"active": true,
"address": "تهران، خیابان انقلاب، پلاک 12",
"postalCode": "1234567890",
"province": "تهران",
"city": "تهران",
"endDate": null
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
24- استعلام اعضای هیئت مدیره (CompanyMembers)
توضیح: فهرست اعضای هیئت مدیره یک شرکت یا سازمان را همراه با اطلاعات مربوط به سمتها و وضعیت آنها ارائه میدهد. این سرویس برای بررسی ساختار مدیریتی و بازرسین و هیئت مدیره کاربرد دارد.
پارامترها:
nationalID (string) – شناسه ملی شرکت
نمونه استفاده:
$nationalID = "14007650912"; $result = $api->CompanyMembers($nationalID); print_r($result);
نمونه پاسخ:
{
"data": {
"boardMembers": [
{
"nationalID": "0010007700",
"firstName": "علی",
"lastName": "رضایی",
"roleCode": 1,
"roleName": "مدیرعامل"
}
],
"shareHolders": [
{
"nationalID": "0010007700",
"firstName": "علی",
"lastName": "رضایی",
"percentage": 0.1
}
]
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
25- استعلام اگهی های روزنامه رسمی (CompanyNewspapers)
توضیح: این وب سرویس اطلاعات آگهیهای منتشر شده در روزنامههای رسمی و محلی شرکت ها استعلام می نماید. این سرویس برای بررسی صحت آگهیها، اطلاعرسانی قانونی و پیگیری موضوعات مرتبط با کسبوکارها و افراد کاربردی است.
پارامترها:
nationalID (string) – شناسه ملی شرکت
نمونه استفاده:
$nationalID = "14007650912"; $result = $api->CompanyNewspapers($nationalID); print_r($result);
نمونه پاسخ:
{
"data": [
{
"newsID": 127530479,
"title": "14007650912",
"nationalID": "14007650912",
"description": "به استناد صورتجلسه هییت مدیره مورخ 1400/9/9 تصمیمات ذیل اتخاذ شد...",
"capital": 500000000,
"publicationDate": "1404/01/01",
"number": "12345",
"city": "تهران",
"page": 24,
"letterDate": "1404/01/02",
"letterNumber": "140330919101129712"
}
],
"success": true,
"code": 1,
"error": null,
"message": null
}
26- استعلام صاحبین حق امضا شرکتها (CompanySignatories)
توضیح: تایید قرارداد ها و امضاء اسناد تنها توسط امضاء دار معتبر است. این سرویس فهرست افرادی که طبق روزنامه رسمی در یک شرکت یا سازمان حق امضا دارند را مشخص می نماید.
پارامترها:
nationalID (string) – شناسه ملی شرکت
نمونه استفاده:
$nationalID = "14000567890"; $result = $api->CompanySignatories($nationalID); print_r($result);
نمونه پاسخ:
{
"data": {
"allowedTopics": "کلیه اوراق اسناد بهادار تعهد آور شرکت ...",
"signholders": {
"obligatorySignature": [
{
"name": "علی رضایی",
"title": "مدیرعامل",
"obligatoryStatus": true,
"personID": "0010007700"
}
],
"normalSignature": [
{
"name": "مریم حسینی",
"title": "مدیر مالی",
"normalStatus": true,
"personID": "0010007701"
}
],
"obligatoryAndNormalSignature": [
{
"name": "حسن کاظمی",
"title": "عضو هیئت مدیره",
"personID": "0010007702"
}
]
}
,
"signatureFullText": "کلیه اوراق اسناد بهادار تعهد آور شرکت از قبیل چک سفته بروات قراردادها عقود اسلامی همچنین کلیه نامههای عادی اداری با امضا ...",
"newspaperDate": "2025-01-01T00:00:00",
"newsletterDate": "2025-01-02T00:00:00",
"title": "دیجی یکالا",
"boardMembers": [
{
"startDate": "2025-01-01T00:00:00",
"endDate": "2025-12-31T00:00:00",
"byNewsID": 3001,
"person": {
"title": "علی رضایی",
"nationalCode": "0055454333"
}
,
"position": {
"title": "مدیر عامل و عضو هییت مدیره",
"firstRole": "عضو هیئت مدیره",
"secondRole": "مدیرعامل"
}
}
]
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
27- سرویس استعلام کدپستی (PostalCodeInfo)
توضیح: با این وب سرویس می توانید با داشتن کد پستی آدرس دقیق آن را از پست استعلام کنید.
پارامترها:
postalCode (string) – کد پستی
نمونه استفاده:
$postalCode = "1234567890"; $result = $api->PostalCodeInfo($postalCode); print_r($result);
نمونه پاسخ:
{
"data": {
"province": "تهران",
"city": "تهران",
"town": "مرکز",
"district": "1",
"street": "انقلاب",
"street2": "12",
"number": "10",
"floor": "1",
"sideFloor": "شرقی",
"buildingName": "ساختمان نمونه",
"description": "بدون توضیح",
"address": "تهران تهران خیابان استاد مطهری ..."
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
28- سرویس رهیگیری بسته پستی (PostalTracking)
توضیح: با سرویس استعلام مرسولات پستی میتوانید وضعیت بستههای پستی خود را بهسادگی و در هر لحظه مشاهده کنید. تنها کافی است کد پیگیری مرسوله را وارد کنید تا اطلاعات کامل شامل نوع ارسال، دفتر پست مبدا، مبدا و مقصد، فرستنده و گیرنده، وزن، هزینه و تمامی رویدادهای مسیر بسته از تولید بارکد تا تحویل نهایی برای شما نمایش داده شود.
پارامترها:
trackingCode (string) – کد رهگیری مرسوله
نمونه استفاده:
$trackingCode = "1234567890"; $result = $api->PostalTracking($trackingCode); print_r($result);
نمونه پاسخ:
{
"data": {
"postType": "سفارشی",
"sourcePostOffice": "دفتر پست مرکزی تهران",
"source": "تهران",
"destination": "مشهد",
"senderName": "علی رضایی",
"receiverName": "سارا احمدی",
"sourcePostalCode": "1234567890",
"destinationPostalCode": "0987654321",
"weight": "500 گرم",
"totalAmount": "150000 ریال",
"details": [
{
"date": "1403/01/15",
"event": "تحویل در مرکز پستی",
"id": "123456",
"postalNode": "تهران، مرکز پستی شمال",
"time": "14:30"
}
]
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
29- سرویس دریافت لوکیشن با کدپستی (PostalCodeLocation)
توضیح: وب سرویس استعلام و دریافت لوکیشن با کد پستی، این وب سرویس نقش مهمی در تحویل و ارسال مرسولات پستی و راهنمایی پستی یا پیک دارد.
پارامترها:
postalCode (string) – کد پستی
نمونه استفاده:
$postalCode = "1234567890"; $result = $api->PostalCodeLocation($postalCode); print_r($result);
نمونه پاسخ:
{
"data": {
"mapUrl": "https://maps.google.com/?q==35.6892,51.3890",
"lat": 35.6892,
"long": 51.389
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
30- استعلام سامانه ثنا (Sana)
توضیح: این وب سرویس با دریافت شماره شناسه ملی، وضعیت داشتن یا نداشتن شماره ثنا را استعلام کرده و نتیجه را بهصورت فوری و دقیق اعلام میکند. این سرویس برای تایید ثبتنام در سیستم ثنا و دسترسی به اطلاعات مرتبط با آن کاربرد دارد.
پارامترها:
nationalCode (string) – کد ملی یا شناسه ملی
isCompany (bool, اختیاری) – حقوقی یا حقیقی (پیشفرض: false)
نمونه استفاده:
$nationalCode = "0010007700"; $isCompany = false; $result = $api->Sana($nationalCode, $isCompany); print_r($result);
نمونه پاسخ:
{
"data": true,
"success": true,
"code": 1,
"error": null,
"message": null
}
31- استعلام تعداد چک برگشتی (UnpaidCheque)
توضیح: تعداد چک برگشتی فرد را استعلام می نماید. این سرویس به بانکها و کسبوکارها کمک میکند تا ریسک اعتباری مشتریان را بهتر ارزیابی و مدیریت کنند.
پارامترها:
nationalCode (string) – کد ملی
نمونه استفاده:
$nationalCode = "0010007700"; $result = $api->UnpaidCheque($nationalCode); print_r($result);
نمونه پاسخ:
{
"data": {
"count": 0
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
32- استعلام رنگ چک صیادی (ChequeColor)
توضیح: سرویس «استعلام رنگ چک» به شما کمک میکند قبل از دریافت چک، از اعتبار مالی صادرکننده مطمئن شوید. با یک استعلام ساده و سریع، وضعیت چک بهصورت رنگی و کاملاً قابلفهم نمایش داده میشود و میزان ریسک معامله را مشخص میکند.
پارامترها:
nationalCode (string) – کد ملی یا شناسه ملی
isCompany (bool, اختیاری) – حقوقی یا حقیقی (پیشفرض: false)
نمونه استفاده:
$nationalCode = "0010007700"; $isCompany = false; $result = $api->ChequeColor($nationalCode, $isCompany); print_r($result);
نمونه پاسخ:
{
"data": {
"chequeColor": "سفید",
"chequeColorCode": 1
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
33- استعلام مشخصات چک صیادی (ChequeInfo)
توضیح: با وبسرویس «استعلام شناسه چک صیادی»، میتوانید اطلاعات کامل و دقیق چکها را در عرض چند ثانیه دریافت کنید. کافی است شناسه چک را وارد کنید تا جزئیاتی مانند نام دارنده، شماره شبا، شماره سریال، تاریخ صدور و نوع چک بهصورت امن و قابل اعتماد در اختیار شما قرار گیرد.
پارامترها:
chequeID (string) – شناسه چک صیاد
نمونه استفاده:
$chequeID = "111110010007700"; $result = $api->ChequeInfo($chequeID); print_r($result);
نمونه پاسخ:
{
"data": {
"iban": "IR820540102680020817909002",
"issuedDate": "1403/01/15",
"expirationDate": "1406/01/15",
"serialNumber": "12345678",
"seriesNumber": "987654",
"chequeType": "BANS",
"branchCode": "1026",
"name": "علی محمدی"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
34- استعلام تسهیلات فعال بانکی (ActiveLoans)
توضیح: وبسرویس استعلام تسهیلات فعال روشی آسان برای مشاهده تسهیلات و وامهای فعال مشتری است. از مجموع وامهای دریافتی و مانده بدهی گرفته تا تسهیلات سررسید گذشته یا معوق اطلاع یابید.
پارامترها:
nationalCode (string) – کد ملی یا شناسه ملی
نمونه استفاده:
$nationalCode = "0010007700"; $result = $api->ActiveLoans($nationalCode); print_r($result);
نمونه پاسخ:
{
"data": {
"count": 3,
"info": {
"nationalCode": "0012345678",
"name": "علی طهرانی",
"totalAmount": 2500000000,
"debtTotalAmount": 1450000000,
"pastExpiredTotalAmount": 320000000,
"deferredTotalAmount": 180000000,
"suspiciousTotalAmount": 95000000,
"dishonored": 120000000
}
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
35- استعلام وضعیت پاسپورت (PassportStatus)
توضیح: اگر در زمینه گردشگری فعالیت می کنید و می خواهید اعتبار پاسپورت فرد را چک کنید، با این سرویس می توانید اعتبار یک پاسپورت را استعلام کنید.
پارامترها:
nationalCode (string) – کد ملی
mobile (string) – موبایل با فرمت 09120001111
نمونه استفاده:
$nationalCode = "0010007700"; $mobile = "09120000000"; $result = $api->PassportStatus($nationalCode, $mobile); print_r($result);
نمونه پاسخ:
{
"data": {
"hasRequest": false,
"requestStatus": "ثبت نشده",
"requestDate": "1404/01/01",
"postalTrackingCode": "PT123456789",
"hasPassport": false,
"passportNumber": "A12345678",
"issueDate": "1404/01/15",
"expirationDate": "1414/01/15",
"passportStatus": "فعال",
"personFound": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
36- استعلام نمره منفی گواهینامه (DrivingScore)
توضیح: اطلاعات مربوط به نمرات منفی ثبتشده روی گواهینامه رانندگی را ارائه میدهد. این سرویس به رانندگان و سازمانهای مرتبط کمک میکند تا وضعیت تخلفات رانندگی و امتیاز باقیمانده گواهینامه را بررسی کنند.
پارامترها:
nationalCode (string) – کد ملی
mobile (string) – شماره موبایل
licenseNumber (string) – شماره گواهینامه
نمونه استفاده:
$nationalCode = "0010007700"; $mobile = "09120000000"; $licenseNumber = "20983905093"; $result = $api->DrivingScore($nationalCode, $mobile, $licenseNumber); print_r($result);
نمونه پاسخ:
{
"data": {
"negativeScore": 0
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
37- استعلام گواهینامه رانندگی (DrivingLisense)
توضیح: وب سرویس استعلام گواهینامه رانندگی، این امکان را به شما می دهد که اعتبار گواهینامه فرد را بررسی کنید.
پارامترها:
nationalCode (string) – کد ملی یا شناسه ملی
mobile (string) – موبایل با فرمت 09120001111
نمونه استفاده:
$nationalCode = "0010007700"; $mobile = "09120000000"; $result = $api->DrivingLisense($nationalCode, $mobile); print_r($result);
نمونه پاسخ:
{
"data": {
"lisenses": [
{
"nationalCode": "0010007700",
"firstName": "علی",
"lastName": "رضایی",
"title": "پايه سوم",
"requestDate": "1404/01/01",
"confirmDate": "1404/01/02",
"printDate": "1404/01/03",
"postalBarcode": "1234567890235907093971s8003",
"rahvarStatus": "تحويل به پست",
"lisenseNumber": "17687675"
}
]
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
38- استعلام خدمت سربازی (MilitaryStatus)
توضیح: این وب سرویس با دریافت کد ملی، کد وضعیت نظام وظیفه، توضیحات مرتبط با وضعیت خدمت و تاریخ اتمام معافیت موقت (در صورت وجود) را ارائه می دهد. این سرویس برای احراز اصالت و بررسی وضعیت نظام وظیفه افراد در فرآیندهای استخدامی و اداری کاربرد دارد.
پارامترها:
nationalCode (string) – کد ملی
نمونه استفاده:
$nationalCode = "0010007700"; $result = $api->MilitaryStatus($nationalCode); print_r($result);
نمونه پاسخ:
{
"data": {
"qualified": true
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
39- استعلام پلاک های فعال (ActivePlates)
توضیح: سرویس «لیست پلاکهای فعال» امکان دسترسی ساده و امن به تمام پلاکهای فعال متعلق به یک فرد را فراهم میکند. با وارد کردن کد ملی و شماره موبایل، میتوانید فهرست کامل پلاکها، وضعیت فعال یا فکشده بودن هر پلاک، تاریخ فک و توضیحات مربوط به آن را مشاهده کنید.
پارامترها:
nationalCode (string) – کد ملی یا شناسه ملی
mobile (string) – موبایل با فرمت 09120001111
نمونه استفاده:
$nationalCode = "0010007700"; $mobile = "09120000000"; $result = $api->ActivePlates($nationalCode, $mobile); print_r($result);
نمونه پاسخ:
{
"data": [
{
"nationalCode": "0012345678",
"plateNumber": "ایران 11 – 1111 ب 11",
"revoked": false,
"revokedDate": "1401/06/01",
"revokedDescription": "مرکز شماره گذاری چیتگر",
"serialNumber": "SN123456789"
}
],
"success": true,
"code": 1,
"error": null,
"message": null
}
40- استعلام تاریخچه پلاک (PlateHistory)
توضیح: با سرویس «تاریخچه پلاک» می توانید با وارد کردن شماره پلاک و کد ملی مالک، میتوانید تاریخچه کامل پلاک، مدل خودرو، سال ساخت، و تاریخ نصب و جداسازی آن را در یک نگاه مشاهده کنید.
پارامترها:
nationalCode (string) – کد ملی
part1 (string) – قسمت اول پلاک (مقدار عددی)
letter (string) – حرف پلاک
part2 (string) – قسمت دوم پلاک (عدد 3 رقمی)
part3 (string) – قسمت سوم پلاک (عدد دو رقمی بخش ایران)
نمونه استفاده:
$nationalCode = "0010007700"; $part1 = "11"; $letter = "ب"; $part2 = "1111"; $part3 = "11"; $result = $api->PlateHistory($nationalCode, $part1, $letter, $part2, $part3); print_r($result);
نمونه پاسخ:
{
"data": {
"plateHistory": [
{
"vehicleSystem": "پژو",
"vehicleType": "206 تیپ 5",
"installDate": "1402/01/01",
"detachDate": "1403/01/01",
"vehicleModel": "1400"
}
],
"description": "دارای مالک - نصب برروی وسیله",
"serialNumber": "123456789"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
41- استعلام مشخصات و مدل خودرو (VehicleInfo)
توضیح: این سرویس با دریافت کد ملی و شماره پلاک، شماره موتور، شماره شاسی، شماره vin و مدل خودرو را بر می گرداند.
پارامترها:
nationalCode (string) – کد ملی
part1 (string) – قسمت اول پلاک (مقدار عددی)
letter (string) – حرف پلاک
part2 (string) – قسمت دوم پلاک (عدد 3 رقمی)
part3 (string) – قسمت سوم پلاک (عدد دو رقمی بخش ایران)
نمونه استفاده:
$nationalCode = "0010007700"; $part1 = "11"; $letter = "ب"; $part2 = "1111"; $part3 = "11"; $result = $api->VehicleInfo($nationalCode, $part1, $letter, $part2, $part3); print_r($result);
نمونه پاسخ:
{
"data": {
"name": "پژو 206",
"engineNumber": "MHA882UJJAJOAQ",
"chassisNumber": "N9JINJWJ2NXVAI31",
"vin": "UK3939028JMJ3P202",
"model": 1403
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
42- وب سرویس استعلام خلافی خودرو (VehicleViolation)
توضیح: از طریق این وب سرویس می توانید میزان خلافی های خودرو را استعلام نمایید.
پارامترها:
nationalCode (string) – کد ملی
mobile (string) – شماره موبایل
part1 (string) – قسمت اول پلاک (مقدار عددی)
letter (string) – حرف پلاک
part2 (string) – قسمت دوم پلاک (عدد 3 رقمی)
part3 (string) – قسمت سوم پلاک (عدد دو رقمی بخش ایران)
نمونه استفاده:
$nationalCode = "0010007700"; $mobile = "09120001111"; $part1 = "11"; $letter = "ب"; $part2 = "1111"; $part3 = "11"; $result = $api->VehicleViolation($nationalCode, $mobile, $part1, $letter, $part2, $part3); print_r($result);
نمونه پاسخ:
{
"data": {
"violations": [
{
"id": "A9F3C21B",
"type": "توقف دوبله در معابر",
"description": "الصاقی",
"code": "2085",
"price": 600000,
"city": "تهران",
"location": "تهران، ولیعصر، بهرامی",
"serial": "999999999_99",
"barcode": "BC-784512369"
}
],
"totalAmount": 600000,
"count": 600000
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
43- استعلام وضعیت اتباع (NationalityStatus)
توضیح: این وب سرویس اطلاعات کارت اتباع را از مراجع انتظامی استعلام می نماید و اعتبار کارت اتباع را مشخص می نماید.
پارامترها:
code (string) – کد
codeType (int, اختیاری) – نوع کد: 1=کد شناسایی تبعه، 2=فیدا، 3=شناسه فراگیر ناجا، 4=کد یکتا (پیشفرض: 2)
نمونه استفاده:
$code = "121302310622"; $codeType = 2; $result = $api->NationalityStatus($code, $codeType); print_r($result);
نمونه پاسخ:
{
"data": {
"id": 1,
"uniqeCode": 12345678901234,
"fidaCode": 987654321,
"birthDate": "2025-12-31T00:00:00",
"birthDatePersian": "1370/01/01",
"firstName": "علی",
"lastName": "رضایی",
"fatherName": "محمد",
"grandFatherName": "حسین",
"gender": 1,
"provinceID": 10,
"province": "تهران",
"nationalityID": 1,
"nationalityName": "افغانستان",
"status": 1,
"familyID": 1234567890,
"exit": true,
"identityCode": 1234567890,
"relative": 0,
"education": 0,
"isActive": true,
"deleteAt": ""
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
44- وب سرویس قبض آب (WatterBill)
توضیح: وضعیت پرداخت قبوض آب مشترکین را بررسی و اطلاعات دقیق از بدهیها و پرداختهای انجامشده ارائه میدهد. این سرویس برای تسهیل مدیریت پرداختها و جلوگیری از قطعی خدمات آب کاربرد دارد.
پارامترها:
billID (string) – شناسه قبض
نمونه استفاده:
$billID = "1100151403410"; $result = $api->WatterBill($billID); print_r($result);
نمونه پاسخ:
{
"data": {
"amount": 150000,
"billID": "1100151403410",
"payID": "987654321",
"date": "1404/01/01"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
45- وب سرویس قبض آب با جزئیات (WatterBillInfo)
توضیح: وضعیت پرداخت قبوض آب مشترکین به همراه مشخصات استعلام می نماید. این سرویس برای تسهیل مدیریت پرداخت ها و جلوگیری از قطعی خدمات آب کاربرد دارد.
پارامترها:
billID (string) – شناسه قبض
نمونه استفاده:
$billID = "1100151403410"; $result = $api->WatterBillInfo($billID); print_r($result);
نمونه پاسخ:
{
"data": {
"info": {
"ownerName": "نسیم مطهری",
"address": "تهران تهران خیایان مطهری",
"postalCode": "1234567890",
"usageType": "خانگی",
"subscription": "555555",
"meterNumber": "987654",
"fileNumber": "101",
"city": "تهران",
"capacity": 25,
"previousReadDate": "1402/1/1"
}
,
"amount": 150000,
"billID": "1100151403410",
"payID": "987654321",
"date": "1404/01/01"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
46- وب سرویس قبض گاز (GasBill)
توضیح: وضعیت پرداخت و بدهیهای قبوض گاز مشترکین را بهصورت دقیق ارائه میکند. این سرویس برای کنترل مصرف، مدیریت پرداختها و جلوگیری از قطعی خدمات گاز کاربرد فراوان دارد.
پارامترها:
billID (string) – شناسه قبض
نمونه استفاده:
$billID = "1100151403410"; $result = $api->GasBill($billID); print_r($result);
نمونه پاسخ:
{
"data": {
"amount": 150000,
"billID": "1100151403410",
"payID": "987654321",
"date": "1404/01/01"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
47- وب سرویس قبض گاز با جزئیات (GasBillInfo)
توضیح: وضعیت پرداخت و بدهی های قبوض گاز مشترکین به همراه مشخصات اشتراک را استعلام می نماید. این سرویس برای کنترل مصرف، مدیریت پرداخت ها و جلوگیری از قطعی خدمات گاز کاربرد فراوان دارد.
پارامترها:
billID (string) – شناسه قبض
نمونه استفاده:
$billID = "1100151403410"; $result = $api->GasBillInfo($billID); print_r($result);
نمونه پاسخ:
{
"data": {
"info": {
"ownerName": "نسیم مطهری",
"address": "تهران تهران خیایان مطهری",
"postalCode": "1234567890",
"usageType": "خانگی",
"subscription": "555555",
"meterNumber": "987654",
"fileNumber": "101",
"city": "تهران",
"capacity": 25,
"previousReadDate": "1402/1/1"
}
,
"amount": 150000,
"billID": "1100151403410",
"payID": "987654321",
"date": "1404/01/01"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
48- وب سرویس قبض برق (PowerBill)
توضیح: اطلاعات مربوط به وضعیت پرداخت قبوض برق و بدهیهای مشترک را ارائه میدهد. این سرویس به مشترکین کمک میکند تا از وضعیت مصرف و پرداختهای خود بهصورت دقیق مطلع شوند و مدیریت بهتری روی قبوض برق خود داشته باشند.
پارامترها:
billID (string) – شناسه قبض
نمونه استفاده:
$billID = "1100151403410"; $result = $api->PowerBill($billID); print_r($result);
نمونه پاسخ:
{
"data": {
"amount": 150000,
"billID": "1100151403410",
"payID": "987654321",
"date": "1404/01/01"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}
49- وب سرویس قبض برق با جزئیات (PowerBillInfo)
توضیح: اطلاعات مربوط به وضعیت پرداخت قبوض برق + مشخصات مشترک را استعلام می نماید. این سرویس به مشترکین کمک می کند تا از وضعیت مصرف و پرداخت های خود به صورت دقیق مطلع شوند و مدیریت بهتری روی قبوض برق خود داشته باشند.
پارامترها:
billID (string) – شناسه قبض
نمونه استفاده:
$billID = "1100151403410"; $result = $api->PowerBillInfo($billID); print_r($result);
نمونه پاسخ:
{
"data": {
"info": {
"ownerName": "نسیم مطهری",
"address": "تهران تهران خیایان مطهری",
"postalCode": "1234567890",
"usageType": "خانگی",
"subscription": "555555",
"meterNumber": "987654",
"fileNumber": "101",
"city": "تهران",
"capacity": 25,
"previousReadDate": "1402/1/1"
}
,
"amount": 150000,
"billID": "1100151403410",
"payID": "987654321",
"date": "1404/01/01"
}
,
"success": true,
"code": 1,
"error": null,
"message": null
}