مستندات API – سرویس شاهکار(تطابق کد ملی و تلفن همراه)
مستندات سرویس API شاهکار (تطابق کد ملی و تلفن همراه)
Shahkar API Documents
نسخه 1.1.0 - 08/20/2023
فهرست مطالب
۱. مقدمه
در سرویس شاهکار یوآیدی، با ارسال کد ملی و تلفن همراه کاربر، تطابق مالکیت (مالکیت تلفن همراه و کد ملی) انجام می‌شود.
۲. فراخوانی سرویس mobile/owner/v2
برای استفاده از سرویس API یوآیدی می‌بایست سرویس زیر با پارامترهای درخواستی فراخوانی نمائید. این سرویس با دریافت کد ملی و تلفن همراه کاربر، تطابق مالکیت این دو مورد را بررسی و در پاسخ، isMatched که بیانگر نتیجه مقایسه است و message که در صورت بروز خطا نوع آن را نشان می‌دهد.
۱.۲. نمونه درخواست
نمونه‌ی درخواست به شرح زیر است:
POST - https://json-api.uid.ir/api/inquiry/mobile/owner/v2
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 | شناسه کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| businessToken | string | Required | توکن کسب‌و‌کار (توسط یوآیدی در اختیار قرار می‌گیرد) |
| nationalId | string | Required | کد ملی کاربر |
| mobileNumber | string | Required | تلفن همراه کاربر به صورت 09xxxxxxxxx |
۳.۲. نمونه پاسخ
{
"responseContext": {
"status": {
"code": 0,
"message": "SUCCESS",
"details": []
},
/***************Other Data***************/
"requestId": "",
"correlationId": "",
"navigationURI": "",
"nextStepToken": "",
"userSessionId": "",
"custom": {}
}
"isMatched": true
}
۴.۲. توضیح پارامترهای پاسخ
| Field | Type | Description |
| isMatched | bool | تطابق مالکیت: true عدم تطابق مالکیت: false |
| code | int | کد خطا |
| message | string | توضیحات خطا |