SDK
Tipizēts TypeScript klients OpenEmail API. Nulle atkarību un viena metode katram galapunktam.
Kas tas ir
Viena pakotne visam API (sūtīšana, veidnes, izsekošana, sarakstes, melnraksti, iezīmes, kontakti, auditorijas, domēni, noteikumi, webhooks, kalendārs, iestatījumi, lomas, dalībnieki un vienreizlietojamās pastkastes) ar tipiem katram pieprasījumam un atbildei, divām kļūdu klasēm, atkārtotiem mēģinājumiem, kas nevar dublēt sūtījumu, un webhook parakstu pārbaudītāju. Bez izpildlaika atkarībām, ESM un CommonJS, uz Node 20+, Bun, Deno un Cloudflare Workers. Tā nes darbvietas atslēgu, tāpēc darbojas serverī, un vienreizlietojamās pastkastes ir vienīgā daļa, kas darbojas arī pārlūkā.
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>',})Kurp doties
Tas aptver API, kas aprakstīts iepriekšējā cilnē
Viss šeit ir tā pati virsma, ko apraksta API atsauce, tāpēc lasiet to, lai uzzinātu, ko galapunkts dara, un šo — lai uzzinātu, kā to izsaukt. Katrai dokumentētajai operācijai ir viena metode, un pakotnes atbilstības pārbaude to pierāda, nolasot OpenAPI dokumentu.