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

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

API استعلام نرخ کرایه حمل بار

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

GET/api/v1/rmto/province-tariff

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

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

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

originCodeintegerالزامی

کد شهر مبدأ

نمونه: 11321000

destCodeintegerالزامی

کد شهر مقصد

نمونه: 11322000

loaderCodeintegerالزامی

کد بارگیر

نمونه: 1

goodsCodeintegerالزامی

کد کالا

نمونه: 1

weightnumberالزامی

وزن بار (تن)

نمونه: 20

companyCommissionnumberالزامی

کمیسیون شرکت (درصد)

نمونه: 0

isTrafficLoadbooleanالزامی

آیا بار ترافیکی است

نمونه: false

پارامترها در query ارسال می‌شوند. هر مقدار الزامی، حداکثر ۱۲۸ کاراکتر و بدون کاراکتر کنترلی است؛ نام فیلدها و حروف آن‌ها را مطابق قرارداد نگه دارید.
پارامتر integer باید عدد صحیح مثبت با ارقام لاتین باشد. کدهای مرجع را به‌جای نام نمایشی گزینه بفرستید.
originCode، destCode، loaderCode و goodsCode باید از فهرست مرجع انتخاب شوند. weight مثبت به تن، companyCommission عدد نامنفی به درصد و isTrafficLoad برابر true یا false است؛ اعشار را با نقطه بفرستید.
Price در data نرخ عرف حمل به ریال و Distance مسافت به کیلومتر است. این مبلغ کرایه حمل است و با هزینه استفاده از API فرق دارد؛ جای قرارداد حمل یا توافق طرفین را نمی‌گیرد.
هر فیلد حداکثر ۱۲۸ نویسه و بدون نویسه کنترلی است؛ ورودی نامعتبر پیش از ارسال به راهداری رد می‌شود.
عدد صحیح مثبت وارد کنید؛ کد شهر، شرکت بیمه، نوع سند، کالا و شماره بار در محدوده int32 و سایر اعداد صحیح در محدوده int64 هستند. شناسه بزرگ را به Number جاوااسکریپت تبدیل نکنید.

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

# 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/province-tariff?originCode=11321000&destCode=11322000&loaderCode=1&goodsCode=1&weight=20&companyCommission=0&isTrafficLoad=false' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-province-tariff-001" \
  --header "Accept: application/json"

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

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

داده‌های پایه برای ورودی API

کد مورد نیازتان را اینجا پیدا کنید

فهرست جاری شهرها، بارگیرها و کالاها را ببینید، کد را کپی کنید یا JSON همین صفحه از فهرست را باز کنید. این بخش استعلام نرخ اجرا نمی‌کند و به کلید API نیاز ندارد.

چه کدی می‌خواهید؟

نام شهر یا استان را جست‌وجو کنید؛ نام کامل موقعیت را پیش از انتخاب بررسی کنید.
فیلد ورودی: originCode / destCode

در حال دریافت فهرست شهر و موقعیت…

پاسخ صفحه‌بندی دارد؛ برای دریافت همه رکوردها، page را تا وقتی data.hasMore برابر true است افزایش دهید. code شناسه ورودی سرویس است؛ sourceId و نام نمایشی جایگزین آن نیستند.

واحدها و کدهای مرجع

وزن ورودی به تن، Price به ریال و Distance به کیلومتر است. کد مبدأ، مقصد، بارگیر و کالا را از فهرست‌های مرجع بردارید. نرخ پاسخ، با هزینه استفاده از API متفاوت است.

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

ساختار پاسخ

JSON

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

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

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

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

فیلد	نوع و مقدار تهی	توضیح
`Distance`	`integer (int32)`غیرتهی	مسافت مسیر
`Price`	`integer (int64)`غیرتهی	نرخ

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