واجهة API للتحقق عبر الرسائل القصيرة لمصادقة OTP (دليل التكامل للمطوّرين)

معلمات API لـ Verify Now

يجب إرسال المعلمات التالية أثناء استخدام واجهات برمجة تطبيقات Verify Now.

عنوان URL الأساسي لواجهة REST API

يجب أن تبدأ جميع نقاط نهاية Platform API التالية بعنوان URL التالي:

إنشاء الرمز المميز (Token)

عند استخدام واجهة API للتحقق عبر الرسائل القصيرة من Verify Now لإرسال رموز التحقق، يجب أن يكون الاستدعاء الأول إلى واجهة API الخاصة بإنشاء الرمز المميز.

تُرجع واجهة API هذه رمزًا مميزًا يجب تضمينه في جميع الاستدعاءات اللاحقة. رمز المصادقة مطلوب للتحقق من المستخدم ويجب تضمينه في رأس (Header) كل طلب.

مسار عنوان URL للطلب:

/auth/v1/authentication/token

cURL

1curl --location 'https://cpaas.messagecentral.com/auth/v1/authentication/token? 
2customerId=%3CCustomerId%3E&key=%3CBase64%20Encrypted%20password%3E&scope=NEW&country=91
3&email=test%40messagecentral.com' \
4--header 'accept: */*'

‍

ملاحظة: لتحويل أمر cURL إلى كود باستخدام Postman، افتح Postman، واستورد الأمر cURL عبر زر «استيراد»، ثم قم بإنشاء الكود بلغتك المفضلة بالنقر فوق الزر «Code» على الجانب الأيمن من الطلب.

الاستجابة: جسون

1{
2  "status": Integer,
3  "token": "String"
4}

إرسال OTP

فيما يلي معاملات الطلب لـإرسال OTP إلى رقم هاتف محمول. يلزم رمز المصادقة لإرسال OTP، ويتم إنشاؤه بواسطة واجهة API الخاصة بإنشاء الرمز المميز (الموضّحة أعلاه).

مسار عنوان URL للطلب:‍

ستؤدي الاستجابة الناجحة إلى إرجاع رمز الحالة 200.

/verification/v3/send

معاملات عنوان URL للطلب:‍

cURL

1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send? 
2countryCode=91&flowType=SMS&mobileNumber=9999999999' \
3--header 'authToken: 
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MCwiZXhwIjo'

‍

ملاحظة: لتحويل أمر cURL إلى كود باستخدام Postman، افتح Postman، واستورد الأمر cURL عبر زر «استيراد»، ثم قم بإنشاء الكود بلغتك المفضلة بالنقر فوق الزر «Code» على الجانب الأيمن من الطلب. يمكنك تغيير أساس FlowType للقناة التي تختارها.

الاستجابة: جسون

1{
2  "responseCode": 200,
3  "message": "SUCCESS",
4  "data": {
5    "verificationId": "xxxx",
6    "mobileNumber": "xxxx",
7    "responseCode": "200",
8    "errorMessage": null,
9    "timeout": "60",
10    "smCLI": null,
11    "transactionId": "xxxx"
12  }
13}

تحقق من صحة OTP

طريقة ValidateOTP هي نقطة نهاية REST API للتحقق من كلمة المرور لمرة واحدة (OTP) للعملاء.

مسار عنوان URL للطلب:

ستؤدي الاستجابة الناجحة إلى إرجاع رمز الحالة 200.

/verification/v3/validateOtp/

cURL

1curl --location 'https://cpaas.messagecentral.com/verification/v3/validateOtp? 
2&verificationId=2949&code=1476' \
3--header 'authToken: 
4eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTMzNDMyQTVGNDIGNzQwNCI6ImIhdCI6MTcxMjExOTA0MC'

‍

ملاحظة: لتحويل أمر cURL إلى كود باستخدام Postman، افتح Postman، واستورد الأمر cURL عبر زر «استيراد»، ثم قم بإنشاء الكود بلغتك المفضلة بالنقر فوق الزر «Code» على الجانب الأيمن من الطلب.

الاستجابة: جسون

ستؤدي الاستجابة الناجحة إلى إرجاع رمز الحالة 200.

1{
2  "responseCode": 200,
3  "message": "SUCCESS",
4  "data": {
5    "verficationId": "xxxx",
6    "mobileNumber": "xxxx",
7    "responseCode": "200",
8    "errorMessage": null,
9    "verificationStatus": "VERIFICATION_COMPLETED",
10    "authToken": null,
11    "transactionId": "xxxx"
12  }
13}

رموز الاستجابة

المساعدة والدعم

للحصول على دعم التنفيذ وأي ملاحظات، يرجى التواصل معنا على: support@messagecentral.com