Aller à la documentation
API

Démarrage rapide

Une clé et un premier envoi.

1. Créer une clé

  1. Ouvrez Paramètres → Clés API. La page n'est présente que si vous êtes propriétaire de la boîte aux lettres.
  2. Nommez-la d'après ce qui l'utilisera. C'est par ce nom que vous la retrouverez le jour où quelque chose doit être révoqué.
  3. Choisissez ses portées. L'envoi uniquement, par défaut.
  4. Restreignez éventuellement les adresses au nom desquelles elle peut envoyer : des domaines entiers, des adresses individuelles, ou les deux. Un domaine entier couvre les adresses qui y seront ajoutées plus tard.
  5. Copiez la clé. Elle n'est affichée qu'une fois et n'est pas récupérable : ce qui est stocké est un hachage à sens unique. Faire tourner la clé plus tard affiche la remplaçante une seule fois, de la même façon.

2. Envoyer quelque chose

npm install @openemail/sdk

Facultatif. Chaque point de terminaison est du simple HTTP et du JSON, et l'onglet curl ci-dessous ne nécessite aucune installation.

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 signifie que c'est parti. Vous récupérez un id. Conservez-le : c'est par lui que vous récupérez le message, lisez sa piste d'événements, ou l'annulez si vous l'aviez planifié.

Vous obtenez un 403 auquel vous ne vous attendiez pas ? GET /addresses liste exactement les adresses au nom desquelles cette clé peut envoyer. Il s'agit presque toujours de la portée d'envoi de la clé, d'un domaine ou d'une adresse qui ne lui a pas été accordé, plutôt que d'un domaine manquant sur l'espace de travail.