مستندات API راننده با کد ملی

راهنمای اتصال سرویس

راننده با کد ملی

استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.

GET/api/v1/rmto/driver/national-id

X-API-Keyدسترسی مورد نیاز: drivers:readپارامترها در Queryمصرف سهمیه طبق شرایط اشتراک

ورودی‌های درخواست

پارامترها را با نام دقیق در query string ارسال کنید. نوع داده و الزامی بودن هر فیلد را پیش از ارسال بررسی کنید.

nationalIdstringالزامی

کد ملی ده رقمی راننده

نمونه: 1234567890

پارامترها در query ارسال می‌شوند. هر مقدار الزامی، حداکثر ۱۲۸ کاراکتر و بدون کاراکتر کنترلی است؛ نام فیلدها و حروف آن‌ها را مطابق قرارداد نگه دارید.
کد ملی دقیقاً ۱۰ رقم لاتین است و به‌صورت رشته ارسال می‌شود؛ صفر ابتدایی را حذف نکنید.
هر فیلد حداکثر ۱۲۸ نویسه و بدون نویسه کنترلی است؛ ورودی نامعتبر پیش از ارسال به راهداری رد می‌شود.

نمونه درخواستسمت سرور

# Use your test key. Example inputs are synthetic; no automatic retry.
# Set BARBAN_API_KEY privately before running this example.
curl --request GET 'https://api.bar-ban.ir/api/v1/rmto/driver/national-id?nationalId=1234567890' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-driver-national-id-001" \
  --header "Accept: application/json"

مقادیر نمونه‌اند. کپی کد هیچ درخواستی ارسال نمی‌کند.

کلید آزمایشی بدون فراخوانی راهداری پاسخ می‌دهد؛ کسر سهمیه به تنظیمات خریداری‌شده پلن بستگی دارد.

قرارداد با WSDL نسخه V03 در 2026-10-20 تطبیق داده شده است؛ موفقیت استعلام عملیاتی نیازمند مجوز و حساب معتبر راهداری است.

ساختار پاسخ

JSON

ابتدا وضعیت HTTP و پوش پاسخ را بررسی کنید. مقادیر این مثال آموزشی‌اند؛ وجود قرارداد، سلامت لحظه‌ای سرویس بالادستی را تضمین نمی‌کند.

نمونه آموزشی پاسخ

{
  "requestId": "example-driver-national-id-001",
  "sandbox": true,
  "found": true,
  "data": {
    "sandbox": true,
    "service": "driver-national-id",
    "message": "احراز هویت و ساختار درخواست معتبر است؛ راهداری فراخوانی نشد."
  },
  "error": null
}

فیلدهای داده پاسخ ۲۲ فیلد

فیلد	نوع و مقدار تهی	توضیح
`BirthCityCode`	`integer (int32)`غیرتهی	کد شهر تولد
`BirthCityName`	`string`می‌تواند null باشد	شهر تولد
`CardNumber`	`string`می‌تواند null باشد	شماره کارت هوشمند
`CardValidationDate`	`object`می‌تواند null باشد	اعتبار کارت هوشمند
`CardValidationDate.Day`	`integer (int32)`غیرتهی	روز
`CardValidationDate.Month`	`integer (1–12)`می‌تواند null باشد	ماه
`CardValidationDate.Year`	`integer (int32)`غیرتهی	سال
`CertifcateIssueCityCode`	`integer (int32)`غیرتهی	کد محل صدور گواهینامه
`CertifcateIssueCityName`	`string`می‌تواند null باشد	محل صدور گواهینامه
`CertifcateNumber`	`string`می‌تواند null باشد	شماره گواهینامه
`Driver_Type`	`string`می‌تواند null باشد	نوع راننده
`Family`	`string`می‌تواند null باشد	نام خانوادگی
`FatherName`	`string`می‌تواند null باشد	نام پدر
`IdentifierNumber`	`string`می‌تواند null باشد	شماره شناسایی
`InsuranceBranch`	`string`می‌تواند null باشد	شعبه بیمه
`InsuranceId`	`string`می‌تواند null باشد	شناسه بیمه
`IsActive`	`boolean`غیرتهی	وضعیت فعال
`Mobile`	`string`می‌تواند null باشد	شماره همراه
`NOVE_GAVAHINAMEH`	`string`می‌تواند null باشد	نوع گواهینامه
`Name`	`string`می‌تواند null باشد	نام
`NationalId`	`string`می‌تواند null باشد	کد ملی
`TARIKH_ETEBAR_KART_SALAMAT`	`string`می‌تواند null باشد	اعتبار کارت سلامت

پاسخ نامنتظره گرفتید؟راهنمای پاسخ‌ها و خطاها آماده اتصال هستید؟مرور نکات محیط عملیاتی