مرحبًا بك في VerifyNow - دليل الإعداد السريع(Developer Integration Guide)

معلمة API للتحقق الآن

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

بقية عناوين URL الأساسية لواجهة برمجة التطبيقات

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

https://cpaas.messagecentral.com

إنشاء رمز

عند استخدام واجهة برمجة تطبيقات التحقق من الرسائل القصيرة الخاصة بـ Verify Now لإرسال رموز التحقق عبر الرسائل القصيرة، يجب أن تكون المكالمة الأولية إلى واجهة برمجة تطبيقات إنشاء الرمز المميز. SMS verification  API to send SMS verification codes, the initial call should be to the token generation API.

تقوم واجهة برمجة التطبيقات هذه بإرجاع رمز مميز يجب تضمينه في جميع المكالمات اللاحقة. يلزم وجود رمز مصادقة للتحقق من صحة المستخدم ويجب تضمينه في قسم العنوان لكل طلب.

مسار عنوان 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 الذي تم إنشاؤه بواسطة واجهة برمجة تطبيقات الرمز المميز التي تم إنشاؤها (والتي يمكنك العثور عليها أعلاه في قسم المقدمة). send OTP  on a mobile number below are the request parameters. The authentication token is required to send OTP which is generated by the generated token API (which you can find above in Introduction section).

مسار عنوان 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