مستندات API

API نام مبدأ بارگیری

راهنمای فنی API باربان؛ از استعلام بارنامه و نرخ کرایه حمل بار تا سرویس‌های راننده، ناوگان و داده‌های حمل‌ونقل.

مرکز توسعه‌دهندگان باربانAPI v1
فایل OpenAPI (در پنجره جدید) وضعیت زنده API
سرویس‌هانشانی و موقعیت
راهنمای اتصال سرویس

نام مبدأ بارگیری

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

این سرویس موقتاً غیرفعال است
قرارداد برای آماده‌سازی اتصال در دسترس است. پیش از درخواست عملیاتی، وضعیت خدمت را با پشتیبانی بررسی کنید.
GET/api/v1/rmto/source-place
X-API-Keyدسترسی مورد نیاز: locations:readپارامترها در Queryمصرف سهمیه طبق شرایط اشتراک

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

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

postalCodestringالزامی

کدپستی ده رقمی مبدأ

نمونه: 1234567890
cityCodeintegerالزامی

کد شهر مبدأ

نمونه: 11321000
  • پارامترها در query ارسال می‌شوند. هر مقدار الزامی، حداکثر ۱۲۸ کاراکتر و بدون کاراکتر کنترلی است؛ نام فیلدها و حروف آن‌ها را مطابق قرارداد نگه دارید.
  • پارامتر integer باید عدد صحیح مثبت با ارقام لاتین باشد. کدهای مرجع را به‌جای نام نمایشی گزینه بفرستید.
  • کدپستی باید دقیقاً ۱۰ رقم لاتین و از نوع رشته باشد.
  • هر فیلد حداکثر ۱۲۸ نویسه و بدون نویسه کنترلی است؛ ورودی نامعتبر پیش از ارسال به راهداری رد می‌شود.
  • عدد صحیح مثبت وارد کنید؛ کد شهر، شرکت بیمه، نوع سند، کالا و شماره بار در محدوده 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/source-place?postalCode=1234567890&cityCode=11321000' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-source-place-001" \
  --header "Accept: application/json"
مقادیر نمونه‌اند. کپی کد هیچ درخواستی ارسال نمی‌کند.

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

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

ساختار پاسخ

JSON

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

نمونه آموزشی پاسخ
{
  "requestId": "example-source-place-001",
  "sandbox": true,
  "found": true,
  "data": {
    "sandbox": true,
    "service": "source-place",
    "message": "احراز هویت و ساختار درخواست معتبر است؛ راهداری فراخوانی نشد."
  },
  "error": null
}
فیلدهای داده پاسخ ۱ فیلد
فیلدنوع و مقدار تهیتوضیح
namestringغیرتهینام مبدأ بارگیری
پاسخ نامنتظره گرفتید؟راهنمای پاسخ‌ها و خطاهاآماده اتصال هستید؟مرور نکات محیط عملیاتی