مستندات API بیمه‌نامه بار

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

بیمه‌نامه بار

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

GET/api/v1/rmto/insurance

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

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

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

companyintegerالزامی

کد شرکت بیمه مطابق InsuranceCompanyEnum؛ برای نمونه ۲ ایران، ۴ آسیا و ۵ دانا

نمونه: 2

insuranceNumberstringالزامی

شماره بیمه‌نامه

نمونه: 123456

پارامترها در query ارسال می‌شوند. هر مقدار الزامی، حداکثر ۱۲۸ کاراکتر و بدون کاراکتر کنترلی است؛ نام فیلدها و حروف آن‌ها را مطابق قرارداد نگه دارید.
پارامتر integer باید عدد صحیح مثبت با ارقام لاتین باشد. کدهای مرجع را به‌جای نام نمایشی گزینه بفرستید.
هر فیلد حداکثر ۱۲۸ نویسه و بدون نویسه کنترلی است؛ ورودی نامعتبر پیش از ارسال به راهداری رد می‌شود.
عدد صحیح مثبت وارد کنید؛ کد شهر، شرکت بیمه، نوع سند، کالا و شماره بار در محدوده int32 و سایر اعداد صحیح در محدوده int64 هستند. شناسه بزرگ را به Number جاوااسکریپت تبدیل نکنید.
شرکت بیمه از فهرست کدهای معتبر V03 انتخاب می‌شود؛ عدد دلخواه یا نام شرکت ورودی معتبر نیست.

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

# 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/insurance?company=2&insuranceNumber=123456' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-insurance-001" \
  --header "Accept: application/json"

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

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

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

ساختار پاسخ

JSON

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

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

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

فیلدهای داده پاسخ ۱۵ فیلد

فیلد	نوع و مقدار تهی	توضیح
`CmpNam`	`string`می‌تواند null باشد	شرکت بیمه
`EndDte`	`string`می‌تواند null باشد	پایان اعتبار
`Endorsments`	`array`می‌تواند null باشد	الحاقیه‌های بیمه
`Endorsments[].IssueDate`	`string`می‌تواند null باشد	تاریخ صدور
`Endorsments[].Text`	`string`می‌تواند null باشد	متن
`ErrorCode`	`integer (int32)`غیرتهی	کد خطا
`ErrorDescription`	`string`می‌تواند null باشد	شرح خطا
`FldNam`	`string`می‌تواند null باشد	رشته بیمه
`IsuDte`	`string`می‌تواند null باشد	تاریخ صدور
`MIsuDte`	`string`می‌تواند null باشد	تاریخ صدور میلادی
`Nam`	`string`می‌تواند null باشد	بیمه‌گذار
`NtlCod`	`string`می‌تواند null باشد	کد ملی بیمه‌گذار
`PlcyDoc`	`string`می‌تواند null باشد	شماره بیمه‌نامه
`SttDte`	`string`می‌تواند null باشد	شروع اعتبار
`UnqCod`	`string`می‌تواند null باشد	کد یکتای بیمه

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