API
شروع سریع
یک کلید و نخستین ارسال.
۱. یک کلید بسازید
- تنظیمات ← کلیدهای API را باز کنید. این صفحه تنها وقتی هست که مالک صندوق پستی باشید.
- نامش را از روی چیزی بگذارید که قرار است از آن استفاده کند. همان نام است که وقتی چیزی باید ابطال شود کمک میکند دوباره پیدایش کنید.
- اسکوپهایش را برگزینید. بهطور پیشفرض فقط ارسال.
- به دلخواه محدود کنید که با چه چیزی میتواند ارسال کند: دامنههای کامل، تکنشانیها، یا هر دو. یک دامنهٔ کامل نشانیهایی را هم که بعداً به آن افزوده میشوند در بر میگیرد.
- کلید را کپی کنید. یک بار نشان داده میشود و بازیابیپذیر نیست: آنچه ذخیره میشود یک هش یکطرفه است. چرخاندن کلید در آینده هم جایگزین را به همین شکل یک بار نشان میدهد.
۲. چیزی بفرستید
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 دقیقاً همان چیزهایی را فهرست میکند که این کلید میتواند با آنها ارسال کند. تقریباً همیشه مسئله اسکوپ ارسال روی کلید است، یا دامنه یا نشانیای که به آن داده نشده، نه نبودن دامنه روی فضای کاری.