PHP code example of mshirmohammadi / api.ir
1. Go to this page and download the library: Download mshirmohammadi/api.ir library . Choose the download type require .
2. Extract the ZIP file and open the index.php.
3. Add this code to the index.php.
<?php
require_once('vendor/autoload.php');
/* Start to develop here. Best regards https://php-download.com/ */
mshirmohammadi / api.ir example snippets
composer
use Shirmohammadi\Api_Services\Api_Services;
$token = "YOUR_API_TOKEN";
$api = new Api_Services($token);
$nationalCode = "11111111111";
$mobile = "09120000000";
$result = $api->Shahkar($nationalCode, $mobile,true);
print_r($result);
$nationalCode = "0010007700";
$mobile = "09120000000";
$result = $api->ShahkarLite($nationalCode, $mobile);
print_r($result);
$nationalCode = "0010007700";
$birthDate = "1371/1/1";
$serialNumber = "i1R8389398";
$result = $api->PersonImage($nationalCode, $birthDate, $serialNumber);
print_r($result);
$nationalCode = "0010007700";
$birthDate = "1371/1/1";
$cardNumber = "6037990000000000";
$result = $api->CardMatch($nationalCode, $birthDate, $cardNumber);
print_r($result);
$nationalCode = "0010007700";
$birthDate = "1371/1/1";
$iban = "IR820540102680020817909002";
$result = $api->IbanMatch($nationalCode, $birthDate, $iban);
print_r($result);
$nationalCode = "0010007700";
$iban = "IR820540102680020817909002";
$result = $api->IbanMatchPro($nationalCode, $iban);
print_r($result);
$voiceID = "397FB7F7-38A5-4748-A72B-352FF36B0D71";
$numbers = ["09120000000", "02112345678"];
$result = $api->makeCall($numbers, $voiceID);
print_r($result);
$code = "12345";
$number = "09121112222";
$result = $api->CallOTP($code, $number);
print_r($result);
$code = "1234";
$number = "09121112222";
$result = $api->CallOTPalt($code, $number);
print_r($result);
$code = "123456";
$mobile = "09120000000";
$template = 1;
$result = $api->SmsOTP($code, $mobile, $template);
print_r($result);
$message = "کاربر گرامی بسته شما با شماره 1828772 به پست ارسال شد";
$mobiles = ["09120001111", "09120002222"];
$result = $api->SendSms($message, $mobiles);
print_r($result);
$nationalCode = "0010007700";
$birthDate = "1371/1/1";
$serialNumber = "i1R8389398";
$videoBase64 = "iVBORw0KGgoAAAANSUhEUgAA...";
$matchingThreshold = 90;
$result = $api->VideoMatch($nationalCode, $birthDate, $serialNumber, $videoBase64, $matchingThreshold);
print_r($result);
$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);
$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);
$nationalCode = "0010007700";
$birthDate = "1371/1/1";
$serialNumber = "i1R8389398";
$imageBase64 = "iVBORw0KGgoAAAANSUhEUgAA...";
$matchingThreshold = 75;
$result = $api->FaceMatch($nationalCode, $birthDate, $serialNumber, $imageBase64, $matchingThreshold);
print_r($result);
$nationalCode = "0010007700";
$birthDate = "1371/1/1";
$serialNumber = "i1R8389398";
$imageBase64 = "iVBORw0KGgoAAAANSUhEUgAA...";
$matchingThreshold = 75;
$result = $api->FaceMatchLite($nationalCode, $birthDate, $serialNumber, $imageBase64, $matchingThreshold);
print_r($result);
$domain = "simano.ir";
$result = $api->Enamad($domain);
print_r($result);
$result = $api->Wallpaper();
print_r($result);
$accountNumber = "3022.100.18878774.1";
$bankCode = "012";
$result = $api->BankAccountInfo($accountNumber, $bankCode);
print_r($result);
$cardNumber = "6037990000000000";
$result = $api->BankCardInfo($cardNumber);
print_r($result);
$cardNumber = "6037990000000000";
$result = $api->CardToIban($cardNumber);
print_r($result);
$iban = "IR820540102680020817909002";
$result = $api->IbanInfo($iban);
print_r($result);
$nationalID = "14007650912";
$result = $api->CompanyInfo($nationalID);
print_r($result);
$nationalID = "14007650912";
$result = $api->CompanyMembers($nationalID);
print_r($result);
$nationalID = "14007650912";
$result = $api->CompanyNewspapers($nationalID);
print_r($result);
$nationalID = "14000567890";
$result = $api->CompanySignatories($nationalID);
print_r($result);
$postalCode = "1234567890";
$result = $api->PostalCodeInfo($postalCode);
print_r($result);
$trackingCode = "1234567890";
$result = $api->PostalTracking($trackingCode);
print_r($result);
$postalCode = "1234567890";
$result = $api->PostalCodeLocation($postalCode);
print_r($result);
$nationalCode = "0010007700";
$isCompany = false;
$result = $api->Sana($nationalCode, $isCompany);
print_r($result);
$nationalCode = "0010007700";
$result = $api->UnpaidCheque($nationalCode);
print_r($result);
$nationalCode = "0010007700";
$isCompany = false;
$result = $api->ChequeColor($nationalCode, $isCompany);
print_r($result);
$chequeID = "111110010007700";
$result = $api->ChequeInfo($chequeID);
print_r($result);
$nationalCode = "0010007700";
$result = $api->ActiveLoans($nationalCode);
print_r($result);
$nationalCode = "0010007700";
$mobile = "09120000000";
$result = $api->PassportStatus($nationalCode, $mobile);
print_r($result);
$nationalCode = "0010007700";
$mobile = "09120000000";
$licenseNumber = "20983905093";
$result = $api->DrivingScore($nationalCode, $mobile, $licenseNumber);
print_r($result);
$nationalCode = "0010007700";
$mobile = "09120000000";
$result = $api->DrivingLisense($nationalCode, $mobile);
print_r($result);
$nationalCode = "0010007700";
$result = $api->MilitaryStatus($nationalCode);
print_r($result);
$nationalCode = "0010007700";
$mobile = "09120000000";
$result = $api->ActivePlates($nationalCode, $mobile);
print_r($result);
$nationalCode = "0010007700";
$part1 = "11";
$letter = "ب";
$part2 = "1111";
$part3 = "11";
$result = $api->PlateHistory($nationalCode, $part1, $letter, $part2, $part3);
print_r($result);
$nationalCode = "0010007700";
$part1 = "11";
$letter = "ب";
$part2 = "1111";
$part3 = "11";
$result = $api->VehicleInfo($nationalCode, $part1, $letter, $part2, $part3);
print_r($result);
$nationalCode = "0010007700";
$mobile = "09120001111";
$part1 = "11";
$letter = "ب";
$part2 = "1111";
$part3 = "11";
$result = $api->VehicleViolation($nationalCode, $mobile, $part1, $letter, $part2, $part3);
print_r($result);
$code = "121302310622";
$codeType = 2;
$result = $api->NationalityStatus($code, $codeType);
print_r($result);
$billID = "1100151403410";
$result = $api->WatterBill($billID);
print_r($result);
$billID = "1100151403410";
$result = $api->WatterBillInfo($billID);
print_r($result);
$billID = "1100151403410";
$result = $api->GasBill($billID);
print_r($result);
$billID = "1100151403410";
$result = $api->GasBillInfo($billID);
print_r($result);
$billID = "1100151403410";
$result = $api->PowerBill($billID);
print_r($result);
$billID = "1100151403410";
$result = $api->PowerBillInfo($billID);
print_r($result);
json
{
"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
}
json
{
"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
}
json
{
"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
}
json
{
"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
}
json
{
"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
}
json
{
"data": [
{
"nationalCode": "0012345678",
"plateNumber": "ایران 11 – 1111 ب 11",
"revoked": false,
"revokedDate": "1401/06/01",
"revokedDescription": "مرکز شماره گذاری چیتگر",
"serialNumber": "SN123456789"
}
],
"success": true,
"code": 1,
"error": null,
"message": null
}
json
{
"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
}
json
{
"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
}
json
{
"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
}
json
{
"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
}
json
{
"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
}
json
{
"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
}