API REST
Votre boîte mail, en simple HTTP.
Envoyez, lisez et gérez le courrier depuis votre propre code. Chaque clé ne détient que les portées que vous lui accordez.
En bref
Qu’est-ce qu’une API e-mail ?
Une API e-mail permet à un logiciel d’envoyer et de lire du courrier via HTTP, sans passer par une application. Une clé sur chaque requête décide de ce à quoi l’appelant peut toucher.
104
opérations documentées
25
domaines entiers d’envoi pour une clé
50
adresses uniques en plus
Comment ça marche
Limitez chaque clé à une tâche
Choisissez les portées d’une clé et, si besoin, les expéditeurs qu’elle peut utiliser. Une portée manquante ou un expéditeur non listé reçoit un 403.
Réessayer sans envoyer deux fois
Chaque envoi reçoit son id msg_ avant que quoi que ce soit ne parte. Une nouvelle tentative avec la même Idempotency-Key renvoie le premier résultat.
Renouvelez le secret, gardez la clé
Le renouvellement ne change que le secret : l’id, les portées et l’historique des requêtes continuent. Une clé révoquée reçoit revoked_api_key.
Portées possibles d’une clé
Trente en tout. Les nouvelles clés commencent avec emails:send.
Envoyez votre premier e-mail
Du simple HTTP et du JSON. Rien à installer.
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>" }'Ce que vous obtenez
Déjà dans le produit
Chaque envoi a un id
/events par destinataire, /tracking pour les ouvertures et les clics.
Un 403 expliqué
GET /ping montre les portées de la clé et ce que son rôle en a laissé.
Les clés via MCP
Le serveur MCP liste, renouvelle, révoque et active aussi les clés.
Bonnes pratiques
En tirer le meilleur parti
- 01
Une clé par service
Révoquer une clé divulguée n’arrête alors qu’une intégration, pas toutes.
- 02
Définissez une Idempotency-Key
Dérivez-la d’une valeur unique, comme un numéro de facture, pour qu’une nouvelle tentative rejoue le premier résultat.
- 03
Restreignez l’expéditeur
Ne listez que les adresses d’où un service envoie. Un domaine entier couvre celles ajoutées plus tard.
Où en est-on
Bon à savoir
- Aucun point de terminaison d’envoi de fichiers
- Les pièces jointes en ligne passent en base64, 5 Mo au total. Au-delà, un fichier de l’espace de travail part par son id, en lien de téléchargement.
- Aucun statut rejeté sur un envoi
- GET /emails liste un message rejeté comme envoyé. Le rejet apparaît sur son destinataire et dans un webhook email.bounced.
Questions
On nous demande souvent
Pour aller plus loin
Fonctionne bien avec
Commencer
Votre domaine,
votre courrier.
Pointez un domaine vers OpenEmail et lisez son courrier dans une boîte mail pensée pour lui. Le forfait gratuit couvre un domaine.
