المطورون

وثائق أوضح للمطورين من أول يوم

Base URL واضحة، Auth header، أمثلة جاهزة، Webhooks، Error Codes، وملف Postman داخل تجربة منظمة وسريعة الفهم.

cURL PHP Laravel WordPress Node Axios Python Flutter Kotlin Java C# Go Ruby

      
cURL • PHP • Laravel • Node • Axios • Python • Flutter • Kotlin • Java • C# • Go • Ruby
1انسخ Base URL و Access Token

ابدأ بسرعة من نفس الصفحة دون البحث بين أماكن متعددة داخل المنصة.

2جرّب OTP أو SMS تشغيلي

اختر السيناريو المناسب ثم شغّل أول طلب تجريبي عبر cURL أو الكود الجاهز.

3اربط Webhook

استقبل sent و delivered و failed داخل نظامك مع retries وسجل واضح للمحاولات.

4تابع التنفيذ من اللوحة

راقب الأجهزة والطابور وحالة الرسائل بدون مغادرة نفس التجربة.

بداية سريعة

ابدأ الربط بثلاثة مسارات واضحة

  • أنشئ Access Token من لوحة العميل.
  • اربط جهاز Android Relay وتأكد من ظهوره online.
  • أرسل أول Send OTP أو Send SMS ثم تابع status والويب هوكس.
أساسيات الطلب
  • Base URL https://sms.yebrax.com/api
  • Auth Header Bearer YOUR_ACCESS_TOKEN
  • Content-Type application/json
  • Relay Mode auto أو manual بحسب إعدادك
Health & Launch endpoints

فحوص خفيفة قبل الإطلاق

يمكنك استخدام نهايتين سريعتين أثناء التطوير أو الـ CI للتأكد أن الخدمة تعمل وأن الحساب أصبح جاهزاً للتشغيل الحقيقي.

GET /v1/healthفحص عام بدون توكن
GET /v1/launch/readinessيعيد تقرير جاهزية الحساب ويتطلب account.read
POST /v1/relay/app/pairربط التطبيق عبر Pairing Code أو QR payload.
نماذج الاستجابات
message.accepted
{
  "ok": true,
  "request_id": "req_01H...",
  "status": "queued",
  "queued_at": "2026-03-14T12:30:00Z"
}
otp.sent
{
  "ok": true,
  "otp_id": "otp_01H...",
  "status": "sent",
  "expires_in_seconds": 300
}
message.status
{
  "ok": true,
  "request_id": "req_01H...",
  "status": "delivered",
  "device_name": "Relay Device 1",
  "attempts": 1
}
أدلة سريعة
OpenAPI

اعتمد ملف OpenAPI وPostman لتوحيد العمل بين المطور والفريق التشغيلي.

Webhook Retry

كل فشل مهم يجب أن يعود إلى نظامك عبر Webhook وسجل محاولات واضح.

Go Live

اختبر health، readiness، وربط الجهاز قبل أول إطلاق حقيقي.

مرجع النهايات

بطاقات واضحة بدل توثيق مبعثر

API

POST /api/v1/sms/send

إرسال رسالة تشغيلية عبر queue مع device routing وحالة راجعة.

API

POST /v1/otp/send

إرسال OTP مع purpose وlocale ومدة صلاحية واضحة.

API

POST /v1/otp/verify

تحقق من الكود وأعد success/failed/expired بشكل واضح.

API

GET /v1/messages/status

اقرأ حالة الرسالة والمحاولات والأسباب عبر request_id.

API

GET /v1/recipients

اقرأ دليل المستلمين المحفوظين وابحث بالاسم أو الرقم.

API

POST /v1/recipient-lists/queue

أرسل قائمة كاملة، وكل رقم يتحول إلى رسالة مستقلة داخل queue.

أحداث الويب هوك
  • message.sent تم الإرسال بنجاح من Relay.
  • message.failed فشل الإرسال مع السبب.
  • otp.verified تم التحقق من OTP.
  • device.offline الجهاز خرج عن الاتصال.
أكواد الأخطاء

unauthorized

المفتاح أو الهيدر غير صحيح.

invalid_device

الجهاز غير متاح أو غير صالح للتوجيه.

rate_limited

تم تجاوز حدود الإرسال أو حدود الأمان.

queue_blocked

الإرسال موقوف مؤقتاً بسبب حالة الطابور أو السياسات.

subscription_expired

الاشتراك منتهي ويحتاج تجديداً.

ما نوع التطبيقات التي يناسبها هذا الربط؟+

يناسب أنظمة تسجيل الدخول، المتاجر، الحجوزات، الفواتير، والتنبيهات التشغيلية التي تحتاج OTP أو رسائل مرتبطة بحدث واضح، وليس حملات تسويق جماعية.

هل توجد أمثلة بلغات مختلفة؟+

نعم. تتوفر أمثلة مباشرة قابلة للنسخ تشمل cURL و PHP و Laravel و Node و Axios و Python و Flutter و Kotlin و Java و C# و Go و Ruby.

هل أستطيع استخدامه للـ OTP فقط؟+

نعم. يمكن أن تعتمد فقط على Send OTP و Verify OTP إذا كان مشروعك يحتاج التحقق دون بقية أنواع الرسائل.

هل يجب أن يكون الجهاز متصلاً دائماً؟+

يُفضّل أن يبقى الجهاز أونلاين مع الصلاحيات والخدمة الأمامية مفعّلة حتى تستمر الرسائل والخطاف الزمني للحالة بشكل طبيعي.

من أين أبدأ عملياً؟+

ابدأ بإنشاء الحساب، ثم اربط جهاز Android Relay، وخذ Access Token، وبعدها جرّب أول طلب من الأمثلة الجاهزة قبل الانتقال إلى webhook وبيئة الإنتاج.

بعد قراءة الوثائق

انتقل إلى التسعير أو افتح الحساب أو اطلب دعماً سريعاً

إذا أصبحت صورة التكامل واضحة، فالخطوة التالية هي الحساب، التسعير، أو رسالة مباشرة إلى فريقنا لتهيئة أسرع.

WhatsApp واتساب