توثيقات واجهة برمجة التطبيقات (API Docs)
مرحباً بك في دليل مطوري EBznz OTP. واجهة برمجة التطبيقات الخاصة بنا مصممة على معمارية RESTful وتتيح لك توليد وإرسال رموز التحقق لعملائك عبر تطبيق الواتساب بشكل فوري وآمن. جميع الطلبات تتم برمجياً عبر بروتوكول HTTPS وتستقبل وترسل البيانات بصيغة JSON الموحدة.
https://otp.ebznz.com/api/v1
مفتاح المصادقة (Authentication)
يتطلب الاتصال بالـ API إرسال مفتاح الـ API الخاص بك والذي يمكنك الحصول عليه من لوحة التحكم. يجب تمرير هذا المفتاح في ترويسة الطلب (Header) تحت مسمى Authorization.
Authorization: Bearer "ebznz_otp_live_your_secret_key"
Content-Type: "application/json"
إرسال رمز OTP جديد
تُستخدم نقطة النهاية هذه لتوليد وإرسال رمز OTP بشكل فوري إلى هاتف العميل.
المعاملات المطلوبة (Request Body Parameters)
| المعامل | النوع | الوصف |
|---|---|---|
| phone | string | رقم الهاتف المستلم بالصيغة الدولية الكاملة وبدون أصفار (مثال: 201016683590). |
| company | string | اسم شركتك أو موقعك الذي سيظهر للعميل في رسالة التوثيق التلقائية. |
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://otp.ebznz.com/api/v1/send",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
"phone" => "201016683590",
"company" => "Salla Store"
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer YOUR_API_KEY",
"Content-Type: application/json"
]
]);
$response = curl_exec($curl);
echo $response;
[
{
"id": "otp_65f1a5b8c3d12",
"company": "Salla Store",
"phone": "201016683590",
"otp": "225868"
}
]
معالجة الأخطاء والمشاكل (Error Handling)
تستخدم بوابتنا الأكواد القياسية لبروتوكول HTTP للإشارة إلى نجاح أو فشل طلب الـ API. في حال حدوث أي خطأ، ستتلقى استجابة واضحة تبيّن سبب المشكلة.
مفتاح الـ API غير صالح أو لم يتم تمريره بشكل صحيح في الترويسة.
المعاملات المرسلة ناقصة أو غير صحيحة (مثل إرسال رقم هاتف غير مكتمل).
لقد تجاوزت حد الطلبات المسموح به (دقيقة واحدة بحد أقصى بين كل توليد).