مستندات API

API وضعیت شرکت در راهداری

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

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

وضعیت شرکت در راهداری

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

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

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

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

این سرویس پارامتر ورودی ندارد.

  • این مسیر پارامتر ورودی ندارد؛ کلید API و شرایط دسترسی همچنان لازم‌اند.
نمونه درخواستسمت سرور
# 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/company/status' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-company-status-001" \
  --header "Accept: application/json"
مقادیر نمونه‌اند. کپی کد هیچ درخواستی ارسال نمی‌کند.

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

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

ساختار پاسخ

JSON

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

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