REST API
Posta kutunuz, düz HTTP üzerinden.
Postayı kendi kodunuzdan gönderin, okuyun ve yönetin. Her anahtar yalnızca ona verdiğiniz kapsamlara sahiptir.
Kısaca
E-posta API'si nedir?
E-posta API'si, yazılımın postayı bir uygulama yerine HTTP üzerinden göndermesini ve okumasını sağlar. Her istekteki anahtar, çağıranın neye dokunabileceğine karar verir.
104
belgelenmiş işlem
25
tam alan adı, tek anahtarın gönderim kapsamında
50
tekil adres, bunlara ek olarak
Nasıl çalışır
Her anahtarı tek bir işle sınırlayın
Bir anahtarın sahip olacağı kapsamları ve isterseniz kullanabileceği göndericileri seçin. Eksik kapsam ya da listede olmayan gönderici 403 alır.
İki kez göndermeden yeniden deneyin
Her gönderim, hiçbir şey çıkmadan önce msg_ id'sini alır. Aynı Idempotency-Key ile yeniden deneme ilk sonucu döndürür.
Gizli anahtarı yenileyin, anahtarı koruyun
Yenileme yalnızca gizli anahtarı değiştirir; id, kapsamlar ve istek geçmişi aynen sürer. İptal edilmiş bir anahtar revoked_api_key yanıtı alır.
Anahtarın alabileceği kapsamlar
Toplam otuz. Yeni anahtarlar emails:send ile başlar.
İlk e-postanızı gönderin
Düz HTTP ve JSON. Kurulacak bir şey yok.
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>" }'Neler sunar
Bugün üründe
Her gönderimin bir id'si var
Alıcı bazında /events, açılma ve tıklamalar için /tracking.
Açıklamalı bir 403
GET /ping, anahtarın kapsamlarını ve rolünün ona bıraktıklarını gösterir.
MCP ile anahtarlar
MCP sunucusu da anahtarları listeler, yeniler, iptal eder ve etkinleştirir.
İyi uygulamalar
En iyi şekilde kullanmak
- 01
Her servise bir anahtar
Böylece sızan bir anahtarı iptal etmek tümünü değil, yalnızca bir entegrasyonu durdurur.
- 02
Bir Idempotency-Key belirleyin
Onu fatura numarası gibi benzersiz bir şeyden türetin ki yeniden deneme ilk sonucu tekrarlasın.
- 03
Göndericiyi daraltın
Yalnızca bir servisin gönderdiği adresleri listeleyin. Tam bir alan adı, sonradan eklenenleri de kapsar.
Şu anki durum
Bilmekte fayda var
- Yükleme uç noktası yok
- Satır içi ekler base64'tür, toplamda 5 MB. Daha büyük dosyalar, çalışma alanı dosya id'siyle indirme bağlantısı olarak gider.
- Gönderimde geri dönme durumu yok
- GET /emails, geri dönen bir mesajı gönderilmiş olarak listeler. Geri dönüş, alıcısında ve bir email.bounced webhook'unda görünür.
Sorular
Sık sorulanlar
Devam edin
Şunlarla iyi çalışır
Başlayın
Alan adınız,
postanız.
Bir alan adını OpenEmail'e yönlendirin ve postasını onun etrafında kurulmuş bir posta kutusunda okuyun. Ücretsiz plan bir alan adını kapsar.
