مرحبًا بك في دليل تكامل VerifyNow SDK

نظرة عامة

تحقق الآن هي خدمة التحقق من رقم الهاتف المحمول والمصادقة التي طورتها مركز الرسائل. يوفر طريقة سريعة وموثوقة وفعالة من حيث التكلفة للتحقق من أرقام الهواتف المحمولة والأداء المصادقة متعددة العوامل (MFA) عبر قنوات الرسائل القصيرة والواتساب.

في النظام البيئي الرقمي، أصبحت أرقام الهواتف المحمولة هوية المستخدم العالمية. تحقق الآن يمكّن تطبيقك - سواء كان الويب أو الهاتف المحمول - من مصادقة أرقام هواتف المستخدمين بسهولة وأمان.

الميزات الرئيسية

• التحقق متعدد القنوات: يدعم VerifyNow تسليم OTP عبر كل من قنوات الرسائل القصيرة والواتساب.
• النماذج المعتمدة مسبقًا ومعرفات المرسل: تمت الموافقة على معرفات المرسل وقوالب الرسائل بالفعل، لذلك لا يتعين عليك انتظار التصريح التنظيمي.
• التراجع التلقائي: في حالة فشل تسليم الرسائل على القناة الأساسية، يقوم النظام تلقائيًا بإعادة المحاولة باستخدام قناة بديلة مدعومة.
• خيارات SDK وواجهة برمجة التطبيقات: اختر بين تثبيت SDK المبسط أو التكامل المباشر مع واجهة برمجة التطبيقات المرنة، اعتمادًا على احتياجات التنفيذ الخاصة بك

حالة الاستخدام: المصادقة المستندة إلى OTP

إنشاء OTP والتسليم

بارامترات قالب الرسالة

المعلمات التالية مطلوبة عند استخدام واجهات برمجة تطبيقات VerifyNow:

يدمج تطبيق المؤسسة التحقق من OTP في سير عمل المصادقة الخاص به، مما يضمن مصادقة المستخدم الآمنة والموثوقة. يوفر هذا الأسلوب تجربة OTP متسقة للمستخدمين في جميع المناطق المدعومة.

تدفق التحقق

سير العمل العام عند دمج VerifyNow SDK على iOS أو Android أو JavaScript:

لماذا تستخدم VerifyNow

قبل إرسال أي رسالة SMS أو WhatsApp دوليًا، يجب على الشركات الحصول على معرف المرسل والموافقات من منظمي الاتصالات - وهي عملية قد تستغرق أسابيع

تلغي VerifyNow هذه الخطوة من خلال توفير معرفات مرسلين وقوالب معتمدة مسبقًا عبر أكثر من 200 دولة، مما يسمح للشركاء بالاندماج والبدء في البث المباشر على الفور.

مع VerifyNow، يؤدي تكامل واحد إلى فتح تطبيقك لجمهور عالمي مع ضمان الامتثال والموثوقية.

آلية احتياطية

يتضمن VerifyNow ميزة احتياطية لضمان تسليم OTP. إذا فشلت القناة الأساسية (مثل الرسائل القصيرة)، فسيقوم VerifyNow تلقائيًا بإعادة المحاولة باستخدام قناة بديلة (مثل WhatsApp).

القنوات الاحتياطية المدعومة حاليًا:

1. رسالة نصية قصيرة ← واتساب
2. WhatsApp → (مخطط للإصدار المستقبلي)

تعد طرق التسليم الإضافية جزءًا من خارطة الطريق - اتصل بك مدير الحساب للحصول على التحديثات.

فوائد تكامل SDK (مقابل API)

ملخص

يوفر استخدام حزمة SDK الخاصة بـ VerifyNow ما يلي:

الخطوات التالية

للتكامل باستخدام حزم SDK، راجع:

إذا كان لديك بالفعل حساب Message Central، فاسترجع بيانات الاعتماد الخاصة بك من وحدة التحكم. للحصول على دعم الإعداد المؤسسي أو التكامل المخصص، اتصل بمدير حساب Message Central.

خطوات الدمج

المتطلبات الأساسية للتكامل

قبل دمج SDK، تأكد من أن لديك حسابًا نشطًا على Message Central. وحدة التحكم المركزية للرسائل

ستحتاج إلى بيانات الاعتماد التالية:

بيانات الاعتماد هذه مطلوبة لبدء طلبات التحقق. سوف تستلمها بمجرد إنشاء حسابك والموافقة عليه.

احصل على معرف العميل أو رمز المصادقة

قم بتسجيل الدخول إلى وحدة تحكم الرسائل المركزية.وحدة التحكم المركزية للرسائل

أو قم بإنشاء واجهة برمجة تطبيقات AuthToken

قبل استخدام VerifyNow SDK للتحقق، يجب أن يكون لديك «AuthToken». تقوم واجهة برمجة التطبيقات هذه بإرجاع رمز مميز يجب تضمينه في جميع المكالمات اللاحقة. يلزم وجود رمز مصادقة للتحقق من صحة المستخدم ويجب تضمينه في قسم العنوان لكل طلب.

معايير الطلب:

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

1/auth/v1/authentication/token

‍‍

cURL

1cURL curl --location 'https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=< CustomerId>&key=&scope=NEW&country=91&email=test@messagecentral.com' \ --header 'accept: */*'

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

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

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

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

تكامل SDK لنظام Android (باستخدام ملف.aar)

يرشدك هذا الدليل إلى دمج VerifyNowSDK في مشروع Android الخاص بك باستخدام ملف.aar المحلي.

أندرويد SDK - v1.0.0

الخطوة 1: أضف ملف.aar

انسخ ملف VerifyNowsdk-release-1.0.0.aar إلى دليل libs/ الخاص بوحدة التطبيق الخاصة بك.

يجب أن تبدو بنية المشروع كما يلي:

الخطوة 2: إضافة تبعية AAR

أضف هذا إلى تبعيات build.gradle.kts لتطبيقك:

dependencies {
 implementation("com.squareup.retrofit2:retrofit:2.11.0")
 implementation("com.squareup.retrofit2:converter-gson:2.11.0") 
 implementation(files("libs/ VerifyNowSDK-release.aar"))
 }

تأكد من تطابق الاسم مع اسم الملف (بدون ملحق.aar)

الخطوة 3: تهيئة SDK

بعد مزامنة المشروع وقبل استخدام أي ميزات تحقق، تأكد من تهيئة SDK بشكل صحيح في فئة التطبيق أو النشاط الرئيسي.

توقيع الوظيفة

VerifyNowSDK.init(
     context: Context
 )

الخطوة 4: استدعاء SDK واستخدامه

بمجرد التهيئة، يمكنك بدء عملية التحقق باستخدام الطرق المتاحة.

توقيع الوظيفة

VerifyNowSDK.verify(
countryCode: String,
mobileNo: String,
customerId: String,
authToken: String,
isFallbackEnable: Boolean = false, // optional
callback: VerificationCallback )

معايير الطلب:

تحدد هذه العلامة ما إذا كنت تريد استخدام احتياطي OTP في حالة فشل التحقق الأساسي.

• تم التعيين إلى true → ستتحول SDK تلقائيًا إلى التحقق البديل المستند إلى OTP في حالة فشل Verify Now
• تم التعيين إلى false ← لم يتم تشغيل أي احتياطي؛ فشل التحقق

رد الاتصال: إعادة الاتصال للتحقق

تحتاج إلى توفير تنفيذ VerificationCallback للتعامل مع نتيجة التحقق.

object : VerificationCallback {
override fun success(success: VerificationSuccess)
{// Called when verification succeeds}override fun failure(error: VerificationError)
{// Called when verification fails}
}

import com.messagecentral.verifynow.VerificationCallback
import com.messagecentral.verifynow.VerifyNowSDK
import com.messagecentral.verifynow.network.VerificationError
import com.messagecentral.verifynow.network.VerificationSuccess

VerifyNowSDK.verify(
countryCode
mobileNo
customerId
authToken
isFallbackEnable
callback = object : VerificationCallback
override fun success(success: VerificationSuccess
Toast.makeText(this@MainActivity, "Verified: ${success .verified} message:
${success.message}
",
).show()
}
override fun failure(error: VerificationError) {
Toast.makeText(this@MainActivity, "Failed: ${error.errorMsg}",
).show
}
)

تكامل SDK IOS (باستخدام ملف.xcframework)

• اسم SDK: تحقق الآن من إصدار SDK -1.0.0.xcframework
• الملف: تحقق من إطار إصدار SDK الجديد -1.0.0.xc

يرشدك هذا الدليل إلى دمج VerifyNowSDK في مشروع IOS الخاص بك باستخدام ملف .xcframework المحلي.

iOS SDK - v1.0.0

• نوع الإصدار: الإصدار العام الأولي - فبراير 2025
• التوافق:
  • يدعم نظام التشغيل iOS 16+
• الميزات:
  • وظيفة التحقق الأساسية من OTP
  • بنية رد الاتصال الموحدة (تختلف صيغة اللغة عن Android)
• القيود:
  • لا يوجد دعم للاختبار الصندقي/الوهمي

الخطوة 1: إضافة ملفات إطار عمل VerifyNowSDK-Release-1.0.0.xcframework

بمجرد التهيئة، يمكنك بدء عملية التحقق باستخدام الطرق المتاحة.

توقيع الوظيفة

VerifyNowSDK.verify(
countryCode: String,
mobileNo: String,
customerId: String,
authToken: String,
isFallbackEnable: Bool = false,
completion: @escaping (VerificationResult<VerificationSuccess, VerificationError>)
)

هل يمكن التراجع: منطقي = خطأ

تحدد هذه العلامة ما إذا كنت تريد استخدام احتياطي OTP في حالة فشل التحقق الأساسي.

• اضبط على true → ستتحول SDK تلقائيًا إلى التحقق المستند إلى OTP في حالة فشل Verify Now.
• اضبط على false ← لم يتم تشغيل أي احتياطي؛ يفشل التحقق إذا لم ينجح USSD.

رد الاتصال: معالج الإكمال

تحتاج إلى تقديم تنفيذ الإكمال للتعامل مع نتيجة التحقق.

switch result {
        case .success(let success):
             print("Verification result: \(success.status), message: \(success.message)")
        case .failure(let error):
             switch error {
                  case .verificationFailed(let errorCode, let errorMessage):
                      print("Verification failed - Code: \(errorCode), Message: \ (errorMessage)")
            }
           @unknown default:
               print("Unknown")
         } 

النجاح (النجاح: التحقق من النجاح): يتم استدعاؤه عند التحقق الناجح. قد يتضمن VerificationSuccess الحالة (200) والرسالة والرسالة التي تم التحقق منها (true)

public struct VerificationSuccess: Codable {
    public let status:Int
    public let verified: Bool
    public let message: String
}

فشل (خطأ: خطأ التحقق): يتم استدعاؤه عند فشل التحقق. يحتوي خطأ التحقق على رمز الخطأ ورسالة الخطأ.

public enum VerificationError: Error {
    case verificationFailed(errorCode: Int, errorMsg: String)
}

مثال للاستخدام:

VerifyNowSDK.verify(countryCode: countryCode,
                    mobileNo: mobileNo,
                    customerId: customerId,
                     authToken: authToken,
                     isFallbackEnable: isFallbackEnable) { result in
   switch result {
        case .success(let success):
                 print("Verification result: \(success.status), message: \(success.message)")
        case .failure(let error):
                 switch error {
                      case .verificationFailed(let errorCode, let errorMsg):
                            print("Verification failed - Code: \(errorCode), Message: \ (errorMsg)")
            }
           @unknown default:
               print("Unknown")
         }

🚨 ملاحظة:

دعم

البريد الإلكتروني للاتصال: support@messagecentral.com