Ves a la documentació
API

Inici ràpid

Una clau i un primer enviament.

1. Crea una clau

  1. Obre Configuració → Claus d'API. La pàgina només hi és si ets el propietari de la bústia.
  2. Posa-li el nom d'allò que la farà servir. Aquest nom és com la tornaràs a trobar quan calgui revocar alguna cosa.
  3. Tria'n els scopes. Només enviament, per defecte.
  4. Opcionalment, limita com pot enviar: dominis sencers, adreces individuals o totes dues coses. Un domini sencer cobreix les adreces que s'hi afegeixin més endavant.
  5. Copia la clau. Es mostra una sola vegada i no es pot recuperar: el que es desa és un hash d'un sol sentit. Si més endavant rotes la clau, el reemplaçament es mostra una sola vegada de la mateixa manera.

2. Envia alguna cosa

npm install @openemail/sdk

Opcional. Tots els endpoints són HTTP i JSON simples, i la pestanya curl de sota no necessita res instal·lat.

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

Un 200 vol dir que ha sortit. Reps un id. Guarda'l: és com obtens el missatge, en llegeixes el rastre d'esdeveniments o el cancel·les si l'havies programat.

Reps un 403 que no esperaves? GET /addresses llista exactament amb quines adreces pot enviar aquesta clau. Gairebé sempre és l'scope d'enviament de la clau, o un domini o una adreça que no se li han donat, i no pas un domini que falti a l'espai de treball.