Créer une clé API

Avec une clé API, une application envoie directement via l'API REST de 2Mail, sans connexion SMTP, et reçoit pour chaque message un identifiant qui permet d'en suivre le statut. Vous créez une clé propre par application, pour pouvoir les révoquer séparément.

Étape 1 : créer la clé

1. Ouvrez dans le tableau de bord de 2Mail la section des clés API.
2. Créez une nouvelle clé et donnez-lui le nom de l'application qui l'utilisera : le nom de votre boutique, de votre CRM, de votre logiciel de facturation. Pas de nom générique comme « production » — dans un an, personne ne saura plus à quoi elle servait.
3. Associez la clé au domaine ou aux domaines d'envoi pour lesquels elle peut envoyer.
4. Enregistrez et copiez la clé immédiatement. Pour des raisons de sécurité, elle n'est affichée en entier qu'une seule fois ; ensuite vous ne voyez plus que le nom et les derniers caractères.

Étape 2 : conserver la clé en sécurité

Placez la clé dans la configuration secrète de votre application — une variable d'environnement ou un gestionnaire de secrets — et jamais dans le code source, un e-mail ou un message de chat. Qui possède la clé peut envoyer au nom de votre domaine. Utilisez une clé distincte pour vos environnements de test et de production, ainsi un test ne touche jamais vos vrais clients.

Étape 3 : utiliser la clé

Votre application transmet la clé dans l'en-tête d'autorisation de chaque requête à l'API. La documentation de l'API e-mail décrit les points d'accès pour envoyer un message, consulter son statut et gérer les listes. Chaque requête qui envoie un message renvoie un identifiant ; conservez-le avec le message dans votre propre système, vous pourrez y rattacher plus tard le statut et les bounces.

Étape 4 : tester

Envoyez un message à une adresse de test externe et vérifiez-le dans le journal de remise du tableau de bord. La ligne du journal indique le nom de la clé utilisée pour l'envoi — pratique pour voir quelle application envoie quoi.

Révoquer ou remplacer une clé

Si vous soupçonnez qu'une clé a fuité, ou si le développeur qui la connaissait s'en va, créez d'abord une nouvelle clé, placez-la dans l'application, et révoquez seulement ensuite l'ancienne. L'application ne s'arrête ainsi jamais. Une clé révoquée cesse de fonctionner immédiatement ; les requêtes qui l'utilisent apparaissent comme refusées dans le journal.

Là où ça coince

• Requête refusée — la clé a été mal copiée, révoquée, ou n'est pas associée au domaine pour lequel vous envoyez.
• Clé perdue — elle ne peut pas être réaffichée ; créez-en une nouvelle.
• Une clé pour tout — ça marche, jusqu'au jour où vous devez couper une seule application. Séparez-les.

Si vous voulez aussi recevoir les remises, bounces et ouvertures dans votre application, configurez un webhook.

Ça ne marche pas ?

Communiquez-nous via contact le nom de la clé et l'heure de votre requête. Jamais la clé elle-même — nous n'avons pas besoin de la voir.