مستندات سرویس API استعلام پلاک های شخص
Check Car Plate-list API Documents
نسخه 1.1.1 - 05/01/2024
فهرست مطالب
بخش اول: فراخوانی Plate-list
این بخش مربوط به هدایت کاربر به سرویس استعلام پلاک یوآیدی می‌باشد.
۱. مقدمه
در سرویس استعلام پلاک یوآیدی، با ارسال کد ملی و شماره تلفن، لیست پلاک‌های ثبت شده به نام فرد را دریافت کنید.
۲. استعلام پلاک فعال یوآیدی
برای استفاده از سرویس API استعلام پلاک یوآیدی میبایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد ملی و شماره موبایل کاربر،پلاک های ثبت شده به نام کاربر را در پاسخ بر می‌گرداند.
۱.۲. نمونه درخواست استعلام پلاک
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/car/plate-list
Content-Type: application/json;charset=UTF-8
{
"requestContext" : {
"apiInfo" : {
"businessId" : <UID_BUSINESS_ID>,
"businessToken" : <UID_BUSINESS_TOKEN>
}
},
"nationalId" : "0123456789",
"mobileNumber" : "09000000000"
}
۲.۲. پارامترها
| Field | Type | Kind | Description |
| businessId | string | Required | شناسه کسب‌و‌کار یا BusinessID (توسط یوآیدی در اختیار شما قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار یا BusinessToken (توسط یوآیدی در اختیار شما قرار می‌گیرد) |
| nationalId | string | Required | کد ملی کاربر |
| mobileNumber | string | Required | تلفن همراه کاربر به صورت 09xxxxxxxxx به نام کاربر |
۳. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "",
"details": []
},
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
},
"plateInfo": [
{
"plkk": <CAR_NUM>,
"mnfkSHDNDATE": "2015-10-10 08:00:00",
"plakNUM": "322345678",
"socialNO": "1234567890",
"description": <DISCRIPTION>,
"secINSERIAL": "12345678912345",
"isFAK": "1"
},
{
"plkk": <CAR_NUM>,
"mnfkSHDNDATE": "",
"plakNUM": "123456789",
"socialNO": "1234567890",
"description": <DISCRIPTION>,
"secINSERIAL": "12345668912345",
"isFAK": "0"
}
]
}
۱.۳.توضیح پارامترهای پاسخ
| Field | Type | Description |
plkk | string | شماره پلاک |
mnfkSHDNDATE | string | تاریخ فک پلاک (در صورت فک شدن) |
plakNUM | string | |
socialNO | string | کد ملی صاحب پلاک |
description | string | توضیحات (در صورت وجود) |
secINSERIAL | string | |
isFAK | bool | وضعیت فک پلاک پلاک فعال است: 0 |
