Přejít na dokumentaci
SDK

SDK

Typovaný TypeScript klient pro OpenEmail API. Nulové závislosti a jedna metoda pro každý endpoint.

Co to je

Jeden balíček nad celým API (odesílání, šablony, sledování, vlákna, koncepty, štítky, kontakty, publika, domény, pravidla, webhooky, kalendář, nastavení, role, členové a jednorázové schránky) s typy pro každý požadavek i odpověď, dvěma třídami chyb, opakováními, která nemohou zdvojit odeslání, a ověřovačem podpisu webhooku. Žádné runtime závislosti, ESM i CommonJS, na Node 20+, Bun, Deno a Cloudflare Workers. Nese klíč pracovního prostoru, takže běží na serveru, a jednorázové schránky jsou jedinou částí, která běží i v prohlížeči.

pnpm add @openemail/sdk
send-email.ts
import { 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>',})

Kam dál

Obaluje API z karty před touto

Všechno tady je stejné rozhraní, jaké dokumentuje API reference, takže tam čtěte, co endpoint dělá, a tady, jak jej zavolat. Pro každou zdokumentovanou operaci existuje jedna metoda a kontrola parity v balíčku to dokazuje čtením dokumentu OpenAPI.