مرجع واجهة برمجة التطبيقات

يسرد هذا المرجع كل نقاط النهاية التي يمكن لأي تكامل استدعاؤها بمفتاح API. وهو مولّد من مستند OpenAPI الخاص بالواجهة نفسها، ومقصور على نقاط النهاية التي تقبل مفتاح API؛ أما نقاط النهاية الخاصة بلوحة العميل (تسجيل الدخول والحساب والفريق والفوترة) فليست جزءًا من الواجهة العامة ولا تظهر هنا. وصف كل نقطة نهاية باللغة الإنجليزية.

العنوان الأساسي والمصادقةنسخ رابط القسم

تُرسل كل الطلبات إلى https://api.mail.land وتحمل مفتاحك في الترويسة X-API-Key:

curl https://api.mail.land/v1/transactional/send \
  -H "X-API-Key: ml_pet_..." \
  -H "Content-Type: application/json" \
  -d '{"from":{"email":"[email protected]"},"to":[{"email":"[email protected]"}],"subject":"Hello","htmlContent":"<p>Hello</p>"}'

تبدأ مفاتيح الإرسال في بيئة الإنتاج بـ ml_pet_ (للرسائل التشغيلية) أو ml_pem_ (للتسويق). وتبدأ مفاتيح بيئة الاختبار بـ ml_set_ أو ml_sem_، ومفاتيح الاستقبال بـ ml_pi_، ومفاتيح التحقق بـ ml_pv_. راجع مفاتيح API.

الأقسامنسخ رابط القسم

تنطبق الأخطاء والحدود على كل نقاط النهاية: راجع رموز الأخطاء وحدود المعدل. وتجد التزام التوافق لـ /v1 في توافق الواجهة.