قبل أن تبدأ
- حساب كونفرلا مع وصول API لمساحتك.
- قدرة على تخزين الأسرار بأمان (لا في مصدر الواجهة الأمامية أو مستودعات عامة).
- خلفية خادم تستطيع استدعاء HTTPS وفرض حدودك الخاصة ومنع الإساءة.
خطوات التنفيذ
صادق واحصل على رمز Bearer
أرسل POST إلى /api/v1/auth/token مع البريد وكلمة المرور واسم الجهاز اختياريًا. استخدم الرمز الراجع كـ Authorization: Bearer. بدّل بيانات الاعتماد إذا تسرّب الرمز.
أرسل رمز OTP
أرسل POST إلى /api/v1/otp/send مع رقم هاتف العميل والغرض الاختياري. لا ترسل إلا عندما يطلب المستخدم التحقق صراحةً. التزم بحدود الواجهة وقواعد منع الإساءة لديك.
تحقق من الرمز
أرسل POST إلى /api/v1/otp/verify مع نفس الرقم والرمز. عامل المحاولات الفاشلة بحذر. تجنّب ردودًا تكشف إن كان الرقم مسجلاً.
تعامل مع الأخطاء بأمان
حوّل أخطاء HTTP إلى رسائل واجهة واضحة. لا تعِد إرسال الرمز تلقائيًا في حلقة. سجّل معرّفات التتبع عند التشخيص مع دعم كونفرلا.
نصائح تختصر الوقت
أبقِ OTP بعيدًا عن العميل العام
نفّذ الإرسال والتحقق من خادمك. تعريض كلمات مرور الحساب أو الرموز طويلة الأمد في جافاسكربت المتصفح حادثة يمكن تجنبها.
OTP ليس قالب واتساب
نقاط OTP للتحقق البرمجي. قوالب واتساب للأعمال صيغ منفصلة معتمدة من Meta لمراسلة العملاء.
أمثلة
الحصول على رمز
بدّل بيانات الاعتماد برمز Bearer قبل أي استدعاء OTP.
POST /api/v1/auth/token
Content-Type: application/json
{
"email": "you@company.com",
"password": "••••••••",
"device_name": "billing-service"
}إرسال والتحقق
خطوتان نموذجيتان للتحقق من خادمك.
POST /api/v1/otp/send
Authorization: Bearer <token>
{
"phone": "+15551234567",
"purpose": "login"
}
POST /api/v1/otp/verify
Authorization: Bearer <token>
{
"phone": "+15551234567",
"code": "123456"
}حل المشكلات
401 Unauthorized على مسارات OTP.
تأكد من وجود رمز Bearer وأنه غير منتهٍ وأن الحساب ما زال يملك الوصول. أعد تشغيل /api/v1/auth/token بعد تغيير كلمة المرور.
الإرسال ينجح والمستخدمون لا يستلمون رمزًا.
تحقق من تنسيق الهاتف الذي تتوقعه التكامل، راجع سجلات التسليم مع دعم كونفرلا، وتأكد أنك لا تبتلع أجسام أخطاء API بصمت.
التحقق يفشل دائمًا.
استخدم نفس تطبيع الرقم في الإرسال والتحقق، وتأكد أن الرمز لم ينتهِ، وأن المستخدم لم يطلب عدة رموز متداخلة.
أسئلة شائعة
ما هو الرابط الأساسي لواجهة البرمجة؟
تُخدم جميع نقاط v1 من نطاق كونفرلا تحت /api/v1 (للعملاء البرمجيين). طلب GET على /api/v1 يعيد مستند اكتشاف JSON صغيرًا مع روابط التوثيق؛ والأدلة المقروءة للبشر تحت /docs.
هل OTP هو نفسه قوالب رسائل واتساب؟
لا. OTP تحقق برمجي. قوالب واتساب صيغ معتمدة من Meta لمراسلة العملاء خارج نافذة 24 ساعة.
هل يمكنني استخدام OTP دون بناء تطبيق كامل؟
إذا احتجت المنتج الإداري فقط فتخطَّ OTP. ابدأ بالبدء ودليل صندوق وارد واتساب؛ وأضف OTP عند الحاجة لتحقق مخصص.