API
البداية السريعة
مفتاح وأول إرسال.
1. أنشئ مفتاحًا
- افتح الإعدادات ← مفاتيح API. الصفحة موجودة فقط إن كنت تملك صندوق البريد.
- سمِّه باسم ما سيستخدمه. فذلك الاسم هو ما تجده به لاحقًا حين يلزم إبطال شيء ما.
- اختر صلاحياته. الإرسال فقط، افتراضيًا.
- اختياريًا ضيّق ما يُسمح له بالإرسال باسمه: نطاقات كاملة، أو عناوين مفردة، أو كلاهما. والنطاق الكامل يغطي العناوين التي تُضاف إليه لاحقًا.
- انسخ المفتاح. يُعرض مرة واحدة ولا يمكن استرجاعه: فما يُخزَّن هو تجزئة أحادية الاتجاه. وتدوير المفتاح لاحقًا يعرض البديل مرة واحدة بالطريقة نفسها.
2. أرسل شيئًا
npm install @openemail/sdkاختياري. كل نقطة نهاية هي HTTP وJSON عاديان، وتبويب curl أدناه لا يحتاج إلى تثبيت أي شيء إطلاقًا.
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>" }'الرمز 200 يعني أنها ذهبت. وتستعيد id. احتفظ به: فهو ما تجلب به الرسالة، أو تقرأ به سجل أحداثها، أو تلغيها إن كنت قد جدولتها.
هل تحصل على 403 لم تتوقعه؟ GET /addresses يسرد بالضبط ما يُسمح لهذا المفتاح بالإرسال باسمه. وهو في الغالب صلاحية الإرسال على المفتاح، أو نطاق أو عنوان لم يُعطَ له، لا نطاق ناقص على مساحة العمل.