المنتج

REST API

أرسل بطلب JSON واحد.

POST /v1/emails
POST /v1/emails
Authorization: Bearer srs_live_...
Idempotency-Key: reset-4821
Content-Type: application/json

{
  "from": "Sender Name <info@example.com>",
  "to": ["user@example.net"],
  "subject": "Reset your password",
  "html": "<p>Click to reset your password.</p>"
}

المصادقة

أرسل مفتاح srs_live_ محدود الصلاحيات صادرًا من لوحة التحكم كرمز Bearer. لكل مفتاح صلاحياته الخاصة (emails:send وwebhooks:write …)؛ تُرفض المفاتيح الملغاة أو المنتهية بالرمز 401.

الموارد الأساسية

  • POST /v1/emails — إدراج رسالة في قائمة الانتظار
  • POST /v1/emails/batch — حتى 100 رسالة في طلب واحد
  • GET /v1/emails — قائمة الرسائل الأخيرة
  • GET /v1/emails/{id} — حالة الرسالة
  • DELETE /v1/emails/{id}/schedule — إلغاء إرسال مجدول

نموذج الاستجابة

الرمز 202 يعني أن الرسالة أُدرجت في قائمة الانتظار وليس أنها وصلت إلى صندوق الوارد. الرمز 403 قد يشير إلى نطاق صلاحية مفقود أو نطاق غير مُتحقَّق منه. الرمز 422 يحجب مستلمًا موقوفًا. الرمز 429 يشير إلى تجاوز حد المعدل.

حدود الخدمة الحالية

ترفض REST API المرفقات. تقبل فقط الرؤوس المخصصة In-Reply-To وReferences وList-Unsubscribe وList-Unsubscribe-Post (حتى 8). البريد المستضاف منفصل: عميل الويب يدعم 20 مرفقًا بإجمالي 25 MiB؛ عميل سطح المكتب المنشور يحد الإرسال بـ10 MiB. يعني HTTP 202 وemail.accepted القبول للمعالجة؛ قبول SMTP لا يضمن التسليم أو الوصول إلى الوارد.