مستندات سرویس API اسعتلام آدرس و کد پستی
Postal Code and Address Inquiry API Documents
نسخه ۱.۱.۰ - ۰۸/۲۰/۲۰۲۳
فهرست مطالب
۱. مقدمه
در سرویس استعلام آدرس و کد پستی یوآیدی، با ارسال کد پستی کاربر، می‌توانید استعلام اطلاعات مربوط به آدرس را دریافت نمائید.
۲. فراخوانی سرویس inquiry/address
برای استفاده از سرویس API استعلام آدرس و کد پستی یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد پستی، اطلاعات آدرس کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/inquiry/address
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 | کد پستی کاربر |
۳.۲. نمونه پاسخ
{
"address": {
"avenue": <AVENUE>,
"floorNumber": <FLOOR_NUMBER>,
"houseNumber":<HOUSE_NUMBER>,
"location": <LOCATION>,
"parish": <PARISH>,
"postalCode": <POSTAL_CODE>,
"preAvenue": <PRE_AVENUE>,
"sideFloor": <SIDE_FLOOR>,
"state": <STATE>,
"townShip": <TOWN_SHIP>,
"village": <VILLAGE>,
"zone": <ZONE>,
"buildingName": <BUILDING_NAME>,
"description": <DESCRIPTION>,
"locationCode": <LOCATION_CODE>
},
// More Response Data
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS.",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
}
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| avenue | string | نام خیابان اصلی (معبر) |
| floorNumber | string | طبقه |
| houseNumber | string | پلاک |
| location | string | عنوان موقعیت (مثال: تهران) |
parish | string | محله یا منطقه (مثال: یوسف آباد) |
postalCode | string | کد پستی کاربر |
preAvenue | string | کوچه (معبر ماقبل آخر) |
sideFloor | string | نوع واحد (شمالی یا جنوبی) |
state | string | نام استان |
townShip | string | نام شهر |
village | string | نام روستا |
zone | string | نام ناحیه (مثال: مرکزی) |
buildingName | string | نام ساختمان |
description | string | توضیحات |
locationCode | string | کد موقعیت (مثال: ۱۳۴۵۶) |
