مستندات وب‌سرویس سرآور
ورود به داشبورد

مرجع api / commercial/companies/{nid}/address/

نشانی ثبت‌شده

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

GETcommercial/companies/{national_id}/address/

نشانی ثبت‌شده فعلی شرکت را برمی‌گرداند (متن، کدپستی، استان، شهر، مختصات جغرافیایی). در صورتی که شرکت نشانی ثبت‌شده فعال نداشته باشد، data برابر null و total_charged برابر 0 خواهد بود.

نیازمند اعتبار20 درخواست در دقیقه

هدرها

X-API-KEYstringبله

کلید api شما.

پارامترهای کوئری

national_idstringبله

شناسه ملی شرکت.

idempotency_keystringبله

UUID یکتا.

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

curl -X GET 'https://saravar.com/api/commercial/companies/12345678901/address/?idempotency_key=550e8400-e29b-41d4-a716-446655440000' \
  -H 'X-API-KEY: <YOUR_API_KEY>'

پاسخ

debit_transaction_idinteger | nullبله

شناسه تراکنش (در صورت data=null برابر null).

total_chargedintegerبله

مبلغ کسر شده. در صورت نبود نشانی برابر 0.

dataAddress | nullبله

شیء { address_text, postal_code, province, city, latitude, longitude } یا null.

نکات قیمت‌گذاری و رفتار

  • در صورتی که نشانی ثبت‌شده موجود نباشد، هیچ هزینه‌ای محاسبه نمی‌شود.
  • حداقل کارمزد فقط در صورت بازگشت نشانی معتبر اعمال می‌شود.

خطاها

400کد وضعیت
علتidempotency_key مفقود یا insufficient_credits.
اقدام پیشنهادیکلید معتبر ارسال کنید یا شارژ کنید.
401کد وضعیت
علتکلید api نامعتبر است.
اقدام پیشنهادیکلید فعال بسازید.
403کد وضعیت
علتاحراز هویت ملی تکمیل نشده.
اقدام پیشنهادیاحراز هویت را تکمیل کنید.
404کد وضعیت
علتشرکت یافت نشد.
اقدام پیشنهادیشناسه ملی را بررسی کنید.
429کد وضعیت
علتاز سقف نرخ عبور کرده‌اید.
اقدام پیشنهادیbackoff اعمال کنید.