مستندات API مختصات جغرافیایی کدپستی

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

مختصات جغرافیایی کدپستی

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

این سرویس موقتاً غیرفعال است

قرارداد برای آماده‌سازی اتصال در دسترس است. پیش از درخواست عملیاتی، وضعیت خدمت را با پشتیبانی بررسی کنید.

GET/api/v1/rmto/postal-code/gnaf

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

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

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

postalCodestringالزامی

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

نمونه: 1234567890

پارامترها در 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/postal-code/gnaf?postalCode=1234567890' \
  --header "X-API-Key: $BARBAN_API_KEY" \
  --header "Idempotency-Key: example-postal-code-gnaf-001" \
  --header "Accept: application/json"

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

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

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

ساختار پاسخ

JSON

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

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

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

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

فیلد	نوع و مقدار تهی	توضیح
`ErrorCode`	`integer (int32)`غیرتهی	کد خطا
`ErrorMessage`	`string`می‌تواند null باشد	شرح خطا
`lat`	`number`غیرتهی	عرض جغرافیایی
`lon`	`number`غیرتهی	طول جغرافیایی

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