مستندات API – سرویس استعلام کد پستی و آدرس
مستندات سرویس API استعلام آدرس و کد پستی
Postal Code and Address Inquiry API Documents
نسخه 1.1.0 - 12/04/2023
فهرست مطالب
۱. مقدمه
در سرویس استعلام آدرس و کد پستی یوآیدی، با ارسال کد پستی کاربر، می‌توانید استعلام اطلاعات مربوط به آدرس را دریافت نمائید.
۲. فراخوانی سرویس inquiry/address/v2
برای استفاده از سرویس API استعلام آدرس و کد پستی یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد پستی، اطلاعات آدرس کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/inquiry/address/v2
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo" : {
"businessId" : <UID_BUSINESS_ID>,
"businessToken" : <UID_BUSINESS_TOKEN>
}
},
"postalCode" : "0123456789"
}
۲.۲. توضیح پارامترهای درخواست
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| postalCode | string | Required | کد پستی کاربر |
۳.۲. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"postalCode": <POSTAL_CODE>,
"address": <ADDRESS>
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
postalCode | string | کد پستی کاربر |
address | string | آدرس کامل |