SDK
Typowany klient TypeScript dla API OpenEmail. Zero zależności i jedna metoda na każdy endpoint.
Czym to jest
Jeden pakiet obejmujący całe API (wysyłka, szablony, śledzenie, wątki, wersje robocze, etykiety, kontakty, grupy odbiorców, domeny, reguły, webhooki, kalendarz, ustawienia, role, członkowie i jednorazowe skrzynki), z typami dla każdego żądania i odpowiedzi, dwiema klasami błędów, ponowieniami, które nie mogą zdublować wysyłki, oraz weryfikatorem podpisu webhooka. Bez zależności w czasie wykonania, ESM i CommonJS, na Node 20+, Bun, Deno i Cloudflare Workers. Nosi klucz przestrzeni roboczej, więc działa na serwerze, a jednorazowe skrzynki to jedyna część działająca także w przeglądarce.
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>',})Dokąd dalej
Opakowuje API z poprzedniej karty
Wszystko tutaj to ta sama powierzchnia, którą opisuje dokumentacja API, więc tam czytaj o tym, co robi endpoint, a tutaj o tym, jak go wywołać. Na każdą udokumentowaną operację przypada jedna metoda, a kontrola zgodności w pakiecie czyta dokument OpenAPI, żeby to udowodnić.