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 متصل کنید و نامههایش را در صندوق پستیای بخوانید که گرد آن ساخته شده است. طرح رایگان یک دامنه را پوشش میدهد.
