SDK
OpenEmail API için tipli bir TypeScript istemcisi. Sıfır bağımlılık ve her uç nokta için bir yöntem.
Nedir
API'nin tamamı üzerinde tek bir paket (gönderim, şablonlar, izleme, konuşmalar, taslaklar, etiketler, kişiler, kitleler, alan adları, kurallar, web kancaları, takvim, ayarlar, roller, üyeler ve tek kullanımlık gelen kutuları); her istek ve yanıt için tipler, iki hata sınıfı, bir gönderimi çoğaltamayan yeniden denemeler ve bir web kancası imza doğrulayıcısı ile birlikte. Çalışma zamanı bağımlılığı yok; ESM ve CommonJS; Node 20+, Bun, Deno ve Cloudflare Workers üzerinde. Bir çalışma alanı anahtarı taşır, yani bir sunucuda çalışır; tek kullanımlık gelen kutuları ise ayrıca tarayıcıda da çalışan tek parçadır.
pnpm add @openemail/sdkimport { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) await openemail.emails.send({ from: 'Acme Billing <[email protected]>', to: '[email protected]', subject: 'Your September invoice', html: '<p>Invoice attached.</p>',})Nereye gitmeli
Bundan önceki sekmedeki API'yi sarmalar
Buradaki her şey, API başvurusunun belgelediği yüzeyin aynısıdır; o yüzden bir uç noktanın ne yaptığı için onu, nasıl çağrılacağı için burayı okuyun. Belgelenen her işlem için bir yöntem vardır ve paketin eşlik denetimi bunu kanıtlamak için OpenAPI belgesini okur.