مستندات API اطلاعات پایه ناوگان

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

اطلاعات پایه ناوگان

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

GET/api/v1/rmto/freighter/card/basic

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

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

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

cardNostringالزامی

شماره کارت هوشمند ناوگان

نمونه: 1234567

پارامترها در 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/freighter/card/basic?cardNo=1234567' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-freighter-card-basic-001" \
  --header "Accept: application/json"

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

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

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

ساختار پاسخ

JSON

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

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

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

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

فیلد	نوع و مقدار تهی	توضیح
`BARGIR_ID`	`integer (int64)`غیرتهی	شناسه بارگیر
`CardNumber`	`string`می‌تواند null باشد	شماره کارت هوشمند
`IsActive`	`boolean`غیرتهی	وضعیت فعال
`LOADER_LINK_TYPE`	`string`می‌تواند null باشد	نوع اتصال بارگیر
`LoadingTypeCode`	`integer (int32)`غیرتهی	کد نوع ناوگان
`LoadingTypeTitle`	`string`می‌تواند null باشد	نوع ناوگان
`MadeYear`	`integer (int32)`غیرتهی	سال ساخت
`Mobile`	`string`می‌تواند null باشد	شماره همراه
`NOVE_GAVAHINAMEH`	`string`می‌تواند null باشد	نوع گواهینامه
`NOVE_NAVGAN_BARI`	`integer (int32)`غیرتهی	نوع ناوگان باری
`PlaqueCityCode`	`integer (int32)`غیرتهی	کد شهر پلاک
`PlaqueCityName`	`string`می‌تواند null باشد	شهر پلاک
`PlaqueNumber`	`string`می‌تواند null باشد	شماره پلاک
`PlaqueSerialNumber`	`string`می‌تواند null باشد	سریال پلاک
`PlaqueType`	`string`می‌تواند null باشد	نوع پلاک
`TARIKH_ETEBAR_MOAYENE_FANI`	`string`می‌تواند null باشد	اعتبار معاینه فنی
`VINCode`	`string`می‌تواند null باشد	شماره شاسی (VIN)
`YearType`	`string`می‌تواند null باشد	نوع سال

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