Ga direct naar de documentatie
API

Snelstart

Een sleutel en een eerste verzending.

1. Maak een sleutel aan

  1. Open Instellingen → API-sleutels. De pagina is er alleen als je eigenaar van de mailbox bent.
  2. Noem hem naar wat hem gaat gebruiken. Via die naam vind je hem terug wanneer er iets ingetrokken moet worden.
  3. Kies zijn scopes. Standaard alleen versturen.
  4. Beperk desgewenst waarvandaan hij mag versturen: hele domeinen, losse adressen, of beide. Een heel domein dekt ook adressen die er later aan worden toegevoegd.
  5. Kopieer de sleutel. Hij wordt één keer getoond en is niet terug te halen: wat er wordt opgeslagen is een eenrichtingshash. De sleutel later roteren toont de vervanger op dezelfde manier één keer.

2. Verstuur iets

npm install @openemail/sdk

Optioneel. Elk endpoint is gewone HTTP en JSON, en het curl-tabblad hieronder vereist helemaal geen installatie.

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>"  }'

Een 200 betekent dat het weg is. Je krijgt een id terug. Bewaar het: daarmee vraag je het bericht op, lees je het gebeurtenissenspoor, of annuleer je het als je het had ingepland.

Krijg je een 403 die je niet verwachtte? GET /addresses toont precies waarvandaan deze sleutel mag versturen. Het is bijna altijd de verzendscope op de sleutel, een domein of een adres dat hij niet heeft gekregen, en niet een ontbrekend domein op de workspace.