REST API
Kutia juaj postare, mbi HTTP të thjeshtë.
Dërgoni, lexoni dhe menaxhoni postën nga kodi juaj. Çdo çelës mban vetëm fushëveprimet që i jepni.
Shkurt
Çfarë është një API emaili?
Një API emaili i lejon softuerit të dërgojë dhe të lexojë postë mbi HTTP, jo përmes një aplikacioni. Një çelës në çdo kërkesë vendos se çfarë mund të prekë thirrësi.
104
veprime të dokumentuara
25
domene të tëra në fushëveprimin e dërgimit të një çelësi
50
adresa të veçanta mbi to
Si funksionon
Një punë për çdo çelës
Zgjidhni fushëveprimet që mban një çelës dhe, sipas dëshirës, dërguesit që mund të përdorë. Një fushëveprim që mungon ose një dërgues jashtë listës merr 403.
Riprovoni pa e dërguar dy herë
Çdo dërgim merr id-në e vet msg_ para se të dalë ndonjë gjë. Një riprovë me të njëjtin Idempotency-Key kthen rezultatin e parë.
Rrotulloni sekretin, mbani çelësin
Rrotullimi ndërron vetëm sekretin, ndaj id-ja, fushëveprimet dhe historiku i kërkesave vazhdojnë. Një çelësi të shfuqizuar i thuhet revoked_api_key.
Fushëveprimet e një çelësi
Tridhjetë gjithsej. Çelësat e rinj nisin me emails:send.
Dërgoni emailin tuaj të parë
HTTP dhe JSON të thjeshtë. Asgjë për të instaluar.
curl -X POST https://api.openemail.uk/emails \ -H "Authorization: Bearer $OPENEMAIL_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "from": "Acme Billing <[email protected]>", "to": ["[email protected]"], "subject": "Your September invoice", "html": "<p>Invoice attached.</p>" }'Çfarë merrni
Në produkt sot
Çdo dërgim ka një id
/events për çdo marrës, /tracking për hapjet dhe klikimet.
Një 403 i shpjeguar
GET /ping tregon fushëveprimet e çelësit dhe çfarë i la roli i tij.
Çelësat përmes MCP
Edhe serveri MCP i liston, i rrotullon, i shfuqizon dhe i aktivizon çelësat.
Praktikë e mirë
Si ta shfrytëzoni plotësisht
- 01
Një çelës për çdo shërbim
Atëherë shfuqizimi i një çelësi të rrjedhur ndalon një integrim, jo të gjitha.
- 02
Vendosni një Idempotency-Key
Nxirreni nga diçka unike, si një numër fature, që një riprovë ta përsërisë rezultatin.
- 03
Ngushtoni dërguesin
Listoni vetëm adresat nga të cilat dërgon një shërbim. Një domen i tërë mbulon edhe ato që shtohen më vonë.
Ku qëndron
Mirë ta dini
- Pa pikë fundore ngarkimi
- Bashkëngjitjet brenda mesazhit janë base64, 5 MB gjithsej. Skedarët më të mëdhenj shkojnë me id-në e skedarit në hapësirën e punës, si lidhje shkarkimi.
- Pa gjendje kthimi te një dërgim
- GET /emails e liston një mesazh të kthyer si të dërguar. Kthimi shfaqet te marrësi i tij dhe në një webhook email.bounced.
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.
