SDK
Un client TypeScript typé pour l'API OpenEmail. Zéro dépendance, et une méthode pour chaque point de terminaison.
Ce que c'est
Un seul paquet pour toute l'API (envoi, modèles, suivi, fils, brouillons, étiquettes, contacts, audiences, domaines, règles, webhooks, calendrier, paramètres, rôles, membres et boîtes jetables) avec des types pour chaque requête et chaque réponse, deux classes d'erreur, des nouvelles tentatives qui ne peuvent pas dupliquer un envoi, et un vérificateur de signature de webhook. Aucune dépendance à l'exécution, ESM et CommonJS, sur Node 20+, Bun, Deno et Cloudflare Workers. Il porte une clé d'espace de travail, il s'exécute donc sur un serveur, et les boîtes jetables sont la seule partie qui fonctionne aussi dans un navigateur.
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>',})Où aller
Il enveloppe l'API de l'onglet précédent
Tout ce qui est ici recouvre la même surface que celle documentée par la référence de l'API : lisez celle-ci pour savoir ce que fait un point de terminaison, et ceci pour savoir comment l'appeler. Il y a une méthode pour chaque opération documentée, et le contrôle de parité du paquet lit le document OpenAPI pour le prouver.