واجهة REST API
صندوق بريدك، عبر HTTP عادي.
أرسل البريد واقرأه وأدِره من كودك أنت. لا يحمل كل مفتاح إلا الصلاحيات التي تمنحه إياها.
باختصار
ما واجهة API للبريد؟
تتيح واجهة API للبريد للبرمجيات أن ترسل البريد وتقرأه عبر HTTP، لا من خلال تطبيق. ومفتاح في كل طلب يحدّد ما يجوز للمستدعي الوصول إليه.
104
عمليات موثّقة
25
نطاقاً كاملاً يرسل باسمها مفتاح واحد
50
عنواناً مفرداً إضافةً إليها
كيف يعمل
قيّد كل مفتاح بمهمة واحدة
اختر الصلاحيات التي يحملها المفتاح، وإن شئت المرسلين الذين يجوز له استخدامهم. الصلاحية الناقصة أو المرسل غير المدرج يُقابَل بالرمز 403.
أعد المحاولة دون الإرسال مرتين
يحصل كل إرسال على معرّف msg_ الخاص به قبل أن يخرج أي شيء. وإعادة المحاولة بترويسة Idempotency-Key نفسها تعيد النتيجة الأولى.
دوّر السرّ، واحتفظ بالمفتاح
التدوير يبدّل السرّ وحده، فيستمر المعرّف والصلاحيات وسجل الطلبات. والمفتاح المُبطَل يُجاب بـ revoked_api_key.
صلاحيات يمكن أن يحملها المفتاح
ثلاثون في المجموع. تبدأ المفاتيح الجديدة بـ emails:send.
أرسل أول بريد لك
HTTP وJSON عاديان. لا شيء لتثبيته.
curl -X POST https://api.openemail.uk/emails \ -H "Authorization: Bearer $OPENEMAIL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "from": "Acme Billing <[email protected]>", "to": ["[email protected]"], "subject": "Your September invoice", "html": "<p>Invoice attached.</p>" }'ما الذي تحصل عليه
في المنتج اليوم
لكل إرسال معرّف
/events لكل مستلم، و/tracking لعمليات الفتح والنقر.
سبب الـ 403 واضح
يعرض GET /ping صلاحيات المفتاح وما أبقاه له دوره.
المفاتيح عبر MCP
خادم MCP أيضاً يسرد المفاتيح ويدوّرها ويبطلها ويفعّلها.
ممارسات جيدة
لتستفيد منه إلى أقصى حد
- 01
مفتاح لكل خدمة
فإبطال مفتاح مسرَّب يوقف حينها تكاملاً واحداً لا كل التكاملات.
- 02
عيّن ترويسة Idempotency-Key
اشتقّها من شيء فريد، كرقم فاتورة، لتعيد المحاولةُ النتيجةَ الأولى.
- 03
ضيّق المرسِل
أدرج فقط العناوين التي ترسل منها الخدمة. والنطاق الكامل يشمل العناوين المضافة لاحقاً.
أين وصلنا
من المفيد معرفته
- لا نقطة نهاية للرفع
- المرفقات المضمّنة بصيغة base64، بإجمالي 5 ميغابايت. والملفات الأكبر تُرسَل بمعرّف ملف في مساحة العمل، كرابط تنزيل.
- لا حالة ارتداد للإرسال
- يسرد GET /emails الرسالة المرتدّة على أنها مُرسَلة. ويظهر الارتداد على مستلمها وفي خطاف ويب email.bounced.
أسئلة
ما يُسأل عنه كثيرًا
تابع القراءة
يعمل جيدًا مع
ابدأ
نطاقك،
بريدك.
وجّه نطاقًا إلى OpenEmail واقرأ بريده في صندوق بريد مبنيّ حوله. الخطة المجانية تشمل نطاقًا واحدًا.
