Tipli SDK'lar
API, tipli metotlar olarak.
@openemail/sdk, OpenEmail API için bağımlılığı olmayan bir TypeScript istemcisidir ve her derlemede API'nin OpenAPI belgesiyle karşılaştırılır.
Kısaca
SDK nedir?
SDK, yani yazılım geliştirme kiti, bir HTTP API'yi tek bir dilin fonksiyonları ve tipleriyle sarar. İstek oluşturmak yerine metot çağırırsınız ve editörünüz, bir şey gönderilmeden önce argümanları denetler.
0
Çalışma zamanı bağımlılığı
30sn
Deneme başına zaman aşımı
2
Tekrarlanabilir çağrılarda yeniden deneme
Nasıl çalışır
Her derlemede API ile karşılaştırılır
Eşitlik denetimi OpenAPI belgesini okur ve sapma olduğunda derlemeyi başarısız kılar: eksik bir metot, işlemi olmayan bir metot ya da yanlış bir kapsam.
İmleç döngüsü olmadan sayfalama
iterate() imleci izler ve her sayfayı ancak döngünüz ona ulaştığında getirir; böylece bir break istekleri durdurur.
Asla iki kez göndermeyen yeniden denemeler
Tekrarlanabilir çağrılar, bekleme süresi artırılarak en fazla iki kez yeniden denenir. Bir gönderim tüm denemelerde aynı idempotency anahtarını kullanır, bu yüzden yeniden deneme özgün iletiyi döndürür.
İlk e-postanızı gönderin
bun add @openemail/sdk ile kurun ve OPENEMAIL_API_KEY değişkenine Ayarlar, API anahtarları bölümünden bir anahtar atayın.
import { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) const email = await openemail.emails.send({ from: 'Acme Billing <[email protected]>', to: '[email protected]', subject: 'Your September invoice', html: '<p>Invoice attached.</p>',}) console.log(email.id, email.status)Neler sunar
Bugün üründe
Node, Bun ve Deno
Node 20 veya üzeri, ESM ya da CommonJS; kendi fetch'inizi de kabul eder.
Erken anahtar denetimi
Yanlış önekli bir anahtar, 401 olarak değil, oluşturma anında hata fırlatır.
Tek istemci, çok sayıda çalışma alanı
Başka bir çalışma alanı adına işlem yapmak için tek bir çağrıda apiKey geçirin.
Dallanabileceğiniz hatalar
OpenEmailApiError; status, code ve requestId ile birlikte isRateLimited ve isNotFound taşır.
İyi uygulamalar
En iyi şekilde kullanmak
- 01
Anahtar ortam değişkeninde
OPENEMAIL_API_KEY'i ayarlayın ve paylaşılan istemcinin okumasına bırakın; böylece kaynak kodda hiçbir anahtar durmaz.
- 02
Tek istemci oluşturun
İstemciyi kendi modülünde bir kez oluşturun ve başka yerlerde içe aktarın.
- 03
Durumu okuyun
Çözümlenen bir gönderim hâlâ sırada, zamanlanmış ya da başarısız olabilir; teslim edildi saymadan önce status alanını okuyun.
Şu anki durum
Bilmekte fayda var
- Sürüm otomasyonu
- Yayınlama elle yapılır; bu yüzden bir sürüm npm'e, değişiklik girdiğinde değil, birisi çalıştırdığında ulaşır.
- Diğer diller
- Yalnızca TypeScript. Henüz Python, Go veya Ruby istemcisi yok.
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.
