وضعیت جاری معرفی‌نامه
استعلام از سرویس راهداری با کنترل دسترسی، ثبت مصرف و پاسخ استاندارد.
GET
/api/v1/rmto/introduce/stateورودی‌های درخواست
پارامترها را با نام دقیق در query string ارسال کنید. نوع داده و الزامی بودن هر فیلد را پیش از ارسال بررسی کنید.
traceCodestringالزامیکد رهگیری معرفی‌نامه
نمونه:123456- پارامترها در 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/introduce/state?traceCode=123456' \
--header "X-API-Key: $BARBAN_API_KEY" \
--header "Idempotency-Key: example-introduce-state-001" \
--header "Accept: application/json"مقادیر نمونه‌اند. کپی کد هیچ درخواستی ارسال نمی‌کند.
کلید آزمایشی بدون فراخوانی راهداری پاسخ می‌دهد؛ کسر سهمیه به تنظیمات خریداری‌شده پلن بستگی دارد.
قرارداد با WSDL نسخه V03 در 2026-10-20 تطبیق داده شده است؛ موفقیت استعلام عملیاتی نیازمند مجوز و حساب معتبر راهداری است.
ساختار پاسخ
JSONابتدا وضعیت HTTP و پوش پاسخ را بررسی کنید. مقادیر این مثال آموزشی‌اند؛ وجود قرارداد، سلامت لحظه‌ای سرویس بالادستی را تضمین نمی‌کند.
نمونه آموزشی پاسخ
{
"requestId": "example-introduce-state-001",
"sandbox": true,
"found": true,
"data": {
"sandbox": true,
"service": "introduce-state",
"message": "احراز هویت و ساختار درخواست معتبر است؛ راهداری فراخوانی نشد."
},
"error": null
}فیلدهای داده پاسخ ۲ فیلد
| فیلد | نوع و مقدار تهی | توضیح |
|---|---|---|
state | integer (int32)غیرتهی | کد وضعیت معرفی‌نامه |
stateName | stringمی‌تواند null باشد | شرح وضعیت معرفی‌نامه |