Belgelere geç
API

Hızlı başlangıç

Bir anahtar ve ilk gönderim.

1. Bir anahtar oluşturun

  1. Ayarlar → API anahtarları'nı açın. Sayfa yalnızca posta kutusunun sahibiyseniz görünür.
  2. Onu kullanacak şeyin adını verin. Bir şeyin iptal edilmesi gerektiğinde onu yeniden bulmanın yolu bu addır.
  3. Kapsamlarını seçin. Varsayılan olarak yalnızca gönderim.
  4. İsteğe bağlı olarak neyin adına gönderebileceğini daraltın: tüm alan adları, tek adresler ya da ikisi birden. Tüm bir alan adı, sonradan eklenen adresleri de kapsar.
  5. Anahtarı kopyalayın. Yalnızca bir kez gösterilir ve kurtarılamaz: saklanan şey tek yönlü bir hash'tir. Anahtarı daha sonra döndürmek de yenisini aynı şekilde bir kez gösterir.

2. Bir şey gönderin

npm install @openemail/sdk

İsteğe bağlı. Her uç nokta düz HTTP ve JSON'dur; aşağıdaki curl sekmesi hiçbir şey kurmanızı gerektirmez.

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, gittiği anlamına gelir. Geriye bir id alırsınız. Saklayın: mesajı getirmenin, olay geçmişini okumanın ya da zamanladıysanız iptal etmenin yolu odur.

Beklemediğiniz bir 403 mü alıyorsunuz? GET /addresses, bu anahtarın tam olarak neyin adına gönderebileceğini listeler. Sorun neredeyse her zaman anahtardaki gönderim kapsamı ya da ona verilmemiş bir alan adı veya adrestir; çalışma alanında eksik bir alan adı değil.