دليل المطور الشامل

ثلاث خطوات بسيطة لدمج نظام التحقق الأكثر أماناً في مشروعك.

🔑 متطلبات البداية

قبل البدء، ستحتاج إلى "مفتاح الوصول" (API Key) الخاص بك. يمكنك العثور عليه في لوحة التحكم. يجب تضمين هذا المفتاح في كل طلب ترسلُه إلى نظامنا.

Authorization: Bearer YOUR_API_KEY
1
POST REQUEST

المرحلة الأولى: طلب الكود

عندما يطلب المستخدم التحقق في تطبيقك، قم بإرسال طلب إلى النظام لتوليد كود فريد له. هذا الكود هو ما سيرسله المستخدم إلينا لاحقاً.

curl -X POST https://api.yourdomain.com/api/generate-code \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"phone": "+201012345678"}'
المتغيرالنوعالوصف
phoneStringرقم الهاتف مع رمز الدولة (مثل +20 أو +218).

🧪 جرب الآن (Try it Out)

✅ سيعود لك النظام بكود مكون من 6 أرقام. اظهر هذا الكود للمستخدم في واجهة تطبيقك.

2

المرحلة الثانية: تحرك المستخدم

اطلب من المستخدم إرسال الكود الذي ظهر له إلى رقم بوت الواتساب الخاص بنا. بمجرد وصول الرسالة، سيقوم النظام بتوثيق هذا الرقم تلقائياً.

رقم البوت المعتمد

+218 92 4136687
فتح محادثة واتساب الآن
3
GET REQUEST

المرحلة الثالثة: التحقق من الحالة

بعد بضع ثوانٍ من إرسال المستخدم للكود، قم بسؤال النظام: "هل قام صاحب هذا الرقم بالتحقق؟".

curl -X GET "https://api.yourdomain.com/api/check-status?phone=+201012345678" \
  -H "Authorization: Bearer YOUR_API_KEY"

🧪 جرب الآن (Check Status)

الحالات المتوقعة (Status Values):

  • verified: تم استلام الكود بنجاح والرقم موثق.
  • pending: لم يتم استلام الكود بعد من هذا الرقم.
  • expired: انتهت صلاحية الطلب (بعد 5 دقائق).

⚠️ رموز الأخطاء الشائعة

الرمزالسبب المتوقع
401مفتاح الـ API غير صحيح أو مفقود.
403لقد استهلكت كامل رصيدك من الطلبات المتاحة.
404لا يوجد طلب تحقق حالي لهذا الرقم.
429تجاوزت حد السرعة في إرسال الطلبات.

هل لديك استفسار تقني؟

تواصل مع الدعم الفني