Piloter Plumail depuis un terminal
Sans agent : l'API REST se pilote à la main, en shell, ou depuis n'importe quel langage. Rien à installer — curl suffit.
Créer une clé d'API
Dans votre espace Plumail : Réglages → API → Nouvelle clé. Nommez-la, cochez les droits, validez. La clé s'affiche UNE seule fois — copiez-la tout de suite. Elle ressemble à « plm_live_ » suivi de trente-deux caractères.
Ranger la clé dans une variable d'environnement
Jamais en clair dans un script partagé. Ajoutez la ligne à votre fichier de profil pour qu'elle survive à la fermeture du terminal.
export PLUMAIL_API_KEY="plm_live_…"Vérifier que c'est branché
Demandez l'état du compte. C'est une lecture seule : rien n'est modifié, rien n'est envoyé. La réponse nomme votre espace et liste vos domaines d'envoi vérifiés — ce sont eux qui décident des adresses depuis lesquelles vous pourrez écrire.
curl -s https://plumail.fr/api/v1/me \ -H "Authorization: Bearer $PLUMAIL_API_KEY"Envoyer un e-mail
L'adresse d'expédition doit être sur un domaine vérifié — l'appel précédent vous a dit lesquels. L'en-tête Idempotency-Key évite un second envoi si la commande est rejouée.
curl -X POST https://plumail.fr/api/v1/emails \ -H "Authorization: Bearer $PLUMAIL_API_KEY" \ -H "Content-Type: application/json" \ -H "Idempotency-Key: essai-1" \ -d '{ "from": "[email protected]", "to": "[email protected]", "subject": "Essai depuis le terminal", "text": "Ça marche." }'La suite
Les autres points d'entrée — abonnés, liste de suppression, campagnes — sont décrits dans la référence, avec un exemple curl chacun. Le fichier OpenAPI permet d'engendrer un client dans votre langage.
curl -s https://plumail.fr/api/v1 # la carte des points d'entrée curl -s https://plumail.fr/openapi.json # la description technique complète
Si quelque chose coince
Les erreurs de l'API portent toutes un code lisible. Voici ceux qu'on rencontre au branchement.
| 401 invalid_api_key | La clé est incomplète (un retour à la ligne s'est glissé au copier-coller) ou elle a été remplacée. Créez-en une neuve. |
|---|---|
| 401 revoked_api_key | La clé a été coupée dans Réglages → API. Créez-en une autre. |
| 403 insufficient_scope | La clé n'a pas le droit demandé. Les droits se choisissent à la création et ne se modifient plus : créez une clé avec le bon périmètre. |
| 422 unverified_from_domain | L'adresse d'expédition n'est pas sur un domaine vérifié de l'espace. Le message d'erreur liste ceux qui le sont. Pour en ajouter un : Domaines → Ajouter un domaine, puis poser les enregistrements DNS. |
| 429 rate_limit_exceeded | Plus de 600 requêtes par minute pour cette clé. L'en-tête Retry-After dit combien de secondes attendre. |