SDK me tipa
API-ja, si metoda me tipa.
@openemail/sdk është një klient TypeScript pa varësi për OpenEmail API, i kontrolluar kundrejt dokumentit të tij OpenAPI në çdo ndërtim.
Shkurt
Çfarë është një SDK?
Një SDK, ose kit zhvillimi softueri, e mbështjell një HTTP API në funksionet dhe tipat e një gjuhe. Ju thërrisni metoda në vend që të ndërtoni kërkesa, dhe redaktuesi juaj i kontrollon argumentet para se të dërgohet diçka.
0
Varësi në kohë ekzekutimi
30s
Kohë skadimi për përpjekje
2
Riprova për thirrjet e përsëritshme
Si funksionon
I kontrolluar kundrejt API-së në çdo ndërtim
Një kontroll barazie lexon dokumentin OpenAPI dhe e rrëzon ndërtimin po pati shmangie: një metodë që mungon, një metodë pa veprim, ose një fushëveprim i gabuar.
Faqosje pa cikël kursori
iterate() ndjek kursorin dhe e merr çdo faqe vetëm kur cikli juaj arrin tek ajo, ndaj një break i ndal kërkesat.
Riprova që nuk dërgojnë kurrë dy herë
Thirrjet e përsëritshme marrin deri në dy riprova me pritje në rritje. Një dërgim përdor të njëjtin çelës idempotence në të gjitha, ndaj një riprovë kthen mesazhin origjinal.
Dërgoni email-in tuaj të parë
Instalojeni me bun add @openemail/sdk dhe vendosni te OPENEMAIL_API_KEY një çelës nga Cilësimet, Çelësat API.
import { init, openemail } from '@openemail/sdk' init({ apiKey: process.env.OPENEMAIL_API_KEY }) const email = await openemail.emails.send({ from: 'Acme Billing <[email protected]>', to: '[email protected]', subject: 'Your September invoice', html: '<p>Invoice attached.</p>',}) console.log(email.id, email.status)Çfarë merrni
Në produkt sot
Node, Bun dhe Deno
Node 20 ose më i ri, ESM ose CommonJS, dhe pranon edhe fetch-in tuaj.
Çelësat kontrollohen herët
Një çelës me parashtesë të gabuar hedh gabim gjatë ndërtimit, jo si 401.
Një klient, shumë hapësira pune
Kaloni apiKey në një thirrje të vetme për të vepruar për një hapësirë tjetër pune.
Gabime për degëzim
OpenEmailApiError mbart status, code dhe requestId, si edhe isRateLimited dhe isNotFound.
Praktikë e mirë
Si ta shfrytëzoni plotësisht
- 01
Çelësi në mjedis
Vendosni OPENEMAIL_API_KEY dhe lëreni klientin e përbashkët ta lexojë, që asnjë çelës të mos rrijë në kodin burimor.
- 02
Ndërtoni një klient
Krijojeni klientin një herë, në modulin e vet, dhe importojeni gjetkë.
- 03
Lexoni statusin
Një dërgim i përfunduar mund të jetë ende në radhë, i planifikuar ose i dështuar, ndaj lexoni status para se ta quani të dorëzuar.
Ku qëndron
Mirë ta dini
- Automatizimi i publikimeve
- Publikimi është manual, ndaj një version mbërrin në npm kur dikush e nis, jo kur hyn ndryshimi.
- Gjuhë të tjera
- Vetëm TypeScript. Ende nuk ka klient për Python, Go ose Ruby.
Pyetje
Pyeten shpesh
Vazhdoni
Shkon mirë me
Filloni
Domeni juaj,
posta juaj.
Drejtojeni një domen te OpenEmail dhe lexojeni në një kuti postare të ndërtuar rreth tij. Plani falas mbulon një domen.
