الـ REST API
أدِر قوايم العملاء وقوايم المنع والحملات، وابعت إيميلات المعاملات، وسجّل الـ Webhooks من أنظمتك. الـ API موجود في كل الباقات.
الرابط الأساسي والتوثيق
كل الطرق بتستخدم الرابط ده وبترجّع JSON:
https://mailhoor.com/api
وثّق كل طلب بمفتاح الـ API في هيدر X-Auth-APIKey. هتلاقي المفتاح في البورتال في الربط → API و SMTP.
curl -s https://mailhoor.com/api/lists \
-H "X-Auth-APIKey: YOUR_API_KEY"
لما تبعت JSON في الطلب، حط Content-Type: application/json.
خلّي المفتاح سري
مفتاح الـ API يقدر يبعت إيميلات ويقرا عملاءك. استخدمه على السيرفر بتاعك بس، ومتحطوش أبداً في كود الموقع اللي بيظهر للزوار أو في تطبيق موبايل. لو المفتاح اتسرّب، ابعت على support@mailhoor.com فوراً عشان نغيّره.
الردود والأخطاء
الطلب الناجح بيرجّع HTTP 200 (أو 201 لما حاجة تتعمل). الطلب الفاشل بيرجّع كود خطأ HTTP عادي، زي 400 لبيانات غلط أو 401 لمفتاح ناقص أو غلط، والرد بيشرح الخطأ.
الطرق المتاحة
قوايم جهات الاتصال
| الطريقة | المسار | الوصف |
|---|---|---|
GET |
/lists |
كل قوايم جهات الاتصال |
POST |
/lists |
عمل قايمة |
GET |
/lists/{id} |
قراءة قايمة |
PATCH |
/lists/{id} |
تعديل قايمة |
DELETE |
/lists/{id} |
مسح قايمة |
POST |
/lists/{id}/feed |
إضافة أو تحديث عميل واحد، وإضافة أو شيل تاجات، أو إلغاء أو إعادة اشتراكه |
POST |
/lists/{id}/add |
إضافة عملاء كتير بصيغة CSV (لحد 25 ميجا في الطلب) |
POST |
/lists/{id}/addunsubs |
إلغاء اشتراك عملاء كتير |
POST |
/lists/{id}/deletecontacts |
شيل عملاء بعناوينهم |
POST |
/lists/{id}/deletedomains |
شيل العملاء على دومينات معيّنة |
GET |
/lists/{id}/domainstats |
عدد العملاء لكل دومين |
POST |
/lists/{id}/export |
تصدير بيانات القايمة |
GET |
/contactdata/{email} |
كل بيانات عميل واحد |
DELETE |
/contactdata/{email} |
مسح كل بيانات عميل واحد |
GET |
/alltags |
كل تاجات العملاء |
قوايم المنع والاستبعاد
| الطريقة | المسار | الوصف |
|---|---|---|
GET / POST |
/supplists |
عرض أو عمل قوايم منع |
GET / PATCH / DELETE |
/supplists/{id} |
قراءة أو تعديل أو مسح قايمة منع |
POST |
/supplists/{id}/add |
إضافة لقايمة منع |
GET |
/exclusion |
قراءة قوايم الاستبعاد |
POST |
/exclusion/{id}/add |
إضافة لقايمة استبعاد |
الحملات (Broadcasts)
| الطريقة | المسار | الوصف |
|---|---|---|
GET / POST |
/broadcasts |
عرض أو عمل حملات |
GET / PATCH / DELETE |
/broadcasts/{id} |
قراءة أو تعديل مسودة أو مسح |
POST |
/broadcasts/{id}/start |
إرسال الحملة دلوقتي |
POST |
/broadcasts/{id}/test |
إرسال إيميل تجريبي |
POST |
/broadcasts/{id}/cancel |
إلغاء الحملة |
POST |
/broadcasts/{id}/duplicate |
نسخ حملة |
POST |
/broadcasts/{id}/update |
تعديل حملة اتبعتت |
POST |
/broadcasts/{id}/export |
تصدير بيانات الحملة |
GET |
/broadcasts/{id}/domainstats |
النتايج حسب مزوّد البريد |
GET |
/broadcasts/{id}/clientstats |
أكتر الأجهزة والمتصفحات والأماكن |
GET |
/broadcasts/{id}/msgs |
رسايل المرتجعات |
أخرى
| الطريقة | المسار | الوصف |
|---|---|---|
POST |
/transactional/send |
إرسال إيميل معاملات. اقرأ إيميلات المعاملات |
GET / POST |
/webhooks |
عرض أو عمل Webhooks. اقرأ الـ Webhooks |
PATCH / DELETE |
/webhooks/{id} |
تعديل أو مسح Webhook |
POST |
/imageupload |
رفع صورة |
GET |
/exports |
الملفات المصدّرة |
GET |
/userroutes |
مسارات الإرسال المتاحة |
المواصفات الكاملة (Swagger 2.0) موجودة على mailhoor.com/openapi.yaml. استوردها في Postman أو Insomnia وجرّب كل طريقة.
مثال: إضافة عميل
curl -s -X POST https://mailhoor.com/api/lists/LIST_ID/feed \
-H "X-Auth-APIKey: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"email": "sara@example.com", "tags": ["webinar-oct"], "data": {"First Name": "Sara", "City": "Cairo"}}'
ضيف بس الناس اللي وافقوا يستقبلوا إيميلات منك.