Zināšanu bāze
REST API
Dokumentēts HTTP API ar atslēgām, ko var izsniegt, ierobežot un atsaukt.
Detaļas
- Ieslēgts visur. API apkalpo 104 dokumentētas operācijas 68 ceļos (emails, threads, drafts, labels, contacts, audiences, domains, templates, rules, roles, members, settings, calendar, tracking, webhooks un konts) aiz apstiprināta OpenAPI 3.1 dokumenta, ko bez atslēgas var izlasīt ar GET /openapi.json. Piekļuvi nosaka darbvietas atslēga, ko izsniedzat sadaļā Settings.
- Noturība, uz kuru agrāk bija jāgaida, ir gatava. Sūtīšana ieraksta rindu, pirms kaut kas tiek izsūtīts, ar publisku id formā msg_ un tam sekojošiem 24 heksadecimāliem simboliem, un GET /emails/{id} to atrisina, līdzās /events ar pēdām par katru saņēmēju un /tracking ar atvēršanām un klikšķiem. Idempotency-Key no 1–255 rakstzīmēm tiek pieteikts pret unikālu indeksu, kas veidots no šīs atslēgas un jūsu API atslēgas kopā, tāpēc atkārtots mēģinājums pēc noildzes atgriež pirmo rezultātu ar Idempotency-Replayed: true, nevis nosūta divreiz. Sūtīšana ar atslēgu atbild ar 200, tiklīdz tā ir nokārtojusies, un ar 202, kamēr tā vēl ir rindā vai ieplānota.
- Atslēgas tiek izgatavotas, ierobežotas, rotētas un atsauktas sadaļā Settings → API keys. Katra atslēga, ko izsniedz konsole, ir oe_live_ atslēga. Prefiksu oe_test_ saprot gan verificētājs, gan sūtīšanas ceļš, kur testa režīma sūtījums tiek ierakstīts un atbildēts kā nosūtīts, nekad nenonākot līdz transportam, taču izgatavot tādu pagaidām neviens nevar, un šīs iespējas piedāvāšana, pirms tukšās darbības transports atrodas virs Durable Object, iedotu jums testa atslēgu, kas piegādā pa īstam. Atslēgai ir sūtīšanas tvērums līdz 25 veseliem domēniem un 50 atsevišķām adresēm, kur vesels domēns aptver arī adreses, kas tam pievienotas vēlāk, neobligāts derīguma termiņš no 1 līdz 3650 dienām un neobligāta loma. Loma ir griesti, nevis otrs piešķīrums: GET /ping atgriež gan atslēgas tvērumus, gan tos, ko tai atstājusi loma, tāpēc 403 par tvērumu, kas atslēgā skaidri nosaukts, ir ar redzamu cēloni. Atsaukšana ir atjauninājums, nevis dzēšana, tāpēc vēlākam izsaukumam tiek pateikts revoked_api_key, nevis tas vienkārši neizdodas autentificēties. Rotācija saglabā par atslēgu visu, izņemot slepeno vērtību: id, tvērumi, sūtīšanas tvērums un pieprasījumu vēsture turpinās, vecā slepenā vērtība zūd brīdī, kad tiek izgatavota jaunā, un atslēga ar keys:write var rotēt pati sevi caur API. Tās pašas darbības — uzskaitīšana, rotēšana, atsaukšana un ieslēgšana — ir pieejamas MCP serverī ikvienam, kura loma drīkst pārvaldīt atslēgas.
- Kas patiešām trūkst: API nav sava augšupielādes galapunkta. Iekļautie pielikumi aiziet kā base64 ar 5 MB kopējo ierobežojumu, bet lielāks fails tiek sūtīts, nosaucot darbvietā jau esošu failu pēc tā id, un tas ceļo kā lejupielādes saite. Atlēcieni tiek apstrādāti pastkastē, nevis sūtīšanas žurnālā: piegādes pārskats tiek parsēts, pēc Message-ID sasaistīts ar oriģinālu, sarakstē apzīmēts un izsūtīts kā email.bounced webhook, taču nekas neraksta atpakaļ sūtīšanas rindā, kuras statusam nav atlēciena stāvokļa, tāpēc caur GET /emails atlēkusi ziņa joprojām lasās kā nosūtīta. Pasts, kas nosūtīts no lietotnes rakstīšanas loga, GET /emails arī neparādās, jo rakstīšanas logs neraksta pa to pašu sūtīšanas ceļu.