مفتاح API
يثبت أن الطلب صادر من حسابك. يُمرَّر في الترويسة X-API-Key.
- ادخل لوحة التحكم ← الإعدادات ← واجهة الإرسال.
- اكتب اسماً للمنصة واضغط «إنشاء مفتاح».
- انسخ المفتاح فوراً. لا يُعرض مرة ثانية.
ترسل رسائل واتساب من متجرك أو نظامك بمفتاح API ورمز الجهاز المتصل.
https://rewhats.reit.sa/api
يثبت أن الطلب صادر من حسابك. يُمرَّر في الترويسة X-API-Key.
يحدد رقم واتساب الذي ستخرج منه الرسالة. الرمز الكامل يظهر في صفحة واجهة الإرسال بعد ربط الجهاز، تحت «رمز رقم واتساب الحالي».
كل رسالة ناجحة تُخصم من رصيد الرسائل. إن انتهى الرصيد يرجع الطلب 403. ردود الذكاء لا تُستدعى من هذا المسار.
من واجهة الإرسال. خزّنه في خادم نظامك، لا في الواجهة الأمامية.
من صفحة الأجهزة بمسح QR أو رمز الاقتران. بعد الاتصال انسخ الرمز الكامل من واجهة الإرسال.
اطلب POST على مسار الإرسال برقم تجريبي قبل أي حملة.
استخدم نفس الطلب من متجرك أو فاتورتك عند كل حدث تريد إبلاغ العميل به.
المسار الأساسي. الرقم بصيغة دولية بدون +، أو بصيغة واتساب.
| الموضع | الاسم | القيمة |
|---|---|---|
| المسار | token |
رمز الجهاز من صفحة الأجهزة |
| الترويسة | X-API-Key |
مفتاح الإرسال |
| الترويسة | Content-Type |
application/json |
| الجسم | contact |
مثال: 9665xxxxxxxx أو 9665xxxxxxxx@s.whatsapp.net |
| الجسم | message |
نص الرسالة، حتى 4096 حرفاً |
curl -X POST "https://rewhats.reit.sa/api/v1/send-message/DEVICE_TOKEN" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{"contact":"9665xxxxxxxx","message":"طلبك رقم 1042 خرج للتوصيل"}'
{
"success": true,
"message": "تم إرسال الرسالة بنجاح",
"messageId": "..."
}
كلها تحت نفس الأساس، وبترويسة X-API-Key. {token} هو رمز الجهاز.
| الطريقة | المسار | الاستخدام |
|---|---|---|
| GET | /api/v1/ping | فحص أن الواجهة تعمل. لا يحتاج مفتاحاً. |
| GET | /api/v1/contacts/{token} | جهات الاتصال المعروفة للجهاز |
| GET | /api/v1/inbox/{token} | المحادثات المفتوحة. أضف ?refresh=1 للتحديث |
| GET | /api/v1/inbox/{token}/numbers | أرقام المحادثات المفتوحة فقط |
| POST | /api/v1/on-whatsapp/{token} | جسم JSON: {"numbers":["9665xxxxxxxx"]} |
| GET | /api/v1/chat/{token}/{contact} | سجل محادثة. contact مثل 9665xxxxxxxx@s.whatsapp.net |
إن كان نظامك يرسل بـ instanceid و token و phone و body، استخدم هذا المسار. هنا token هو مفتاح API، وinstanceid رقم الجهاز أو رمزه.
curl -X POST "https://rewhats.reit.sa/api/sendMessage" \
-H "Content-Type: application/json" \
-d '{"token":"YOUR_API_KEY","instanceid":"DEVICE_ID","phone":"9665xxxxxxxx","body":"تم استلام طلبك"}'
{
"sent": true,
"id": "...",
"message": "Message queued/sent"
}
| الحالة | المعنى | ما تراجعه |
|---|---|---|
401 |
المفتاح ناقص أو متوقف | الترويسة X-API-Key، وأن المفتاح لم يُوقف من واجهة الإرسال |
403 |
لا رصيد، أو الرمز ليس لجهازك | رصيد الرسائل، ورمز الجهاز المنسوخ من حسابك |
404 |
الجهاز غير موجود في مسار التوافق | instanceid: رقم الجهاز أو رمزه، والحالة متصلة |
422 |
الرقم أو النص فارغ | phone و body في مسار التوافق |
لا تضع المفتاح في تطبيق الجوال أو صفحة المتجر الظاهرة للزائر. أوقفه من واجهة الإرسال إن انكشف.