Authentification

Mailbeam authentifie les requêtes par clé d'API. Toute requête doit porter une clé d'API valide dans l'en-tête Authorization.

Jeton Bearer

Passez votre clé d'API comme jeton Bearer dans chaque requête :

Authorization: Bearer mb_live_xxxxxxxxxxxxxxxxxxxx

Exemple avec cURL :

curl -X POST https://api.mailbeam.dev/v1/verify \
  -H "Authorization: Bearer $MAILBEAM_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'

Préfixes de clé

Les clés d'API Mailbeam portent un préfixe qui indique leur environnement :

Utilisez les clés mb_test_ en développement et en intégration continue. Une clé de test renvoie des réponses fixes selon le domaine de l'adresse :

• @valid.mailbeam-test.dev → renvoie toujours { valid: true, score: 99 }
• @invalid.mailbeam-test.dev → renvoie toujours { valid: false, score: 0 }
• @disposable.mailbeam-test.dev → renvoie toujours { valid: false, disposable: true }

Variables d'environnement

N'écrivez jamais une clé d'API en dur dans votre code source. Passez par des variables d'environnement :

# .env.local
MAILBEAM_KEY=mb_live_xxxxxxxxxxxxxxxxxxxx

const headers = {
  Authorization: `Bearer ${process.env.MAILBEAM_KEY}`,
  "Content-Type": "application/json",
};

Rotation des clés

Faites tourner vos clés d'API périodiquement, et immédiatement si l'une d'elles est compromise :

1. Allez sur la page des clés d'API de votre tableau de bord
2. Cliquez sur Créer une clé pour en générer une nouvelle
3. Mettez votre application à jour avec la nouvelle clé
4. Cliquez sur Révoquer sur l'ancienne une fois le trafic basculé

Révoquer une clé l'invalide immédiatement. Les requêtes qui l'utilisent renvoient 401 Unauthorized.

Plusieurs clés

Vous pouvez créer jusqu'à 10 clés d'API par compte. Nous conseillons :

• Une clé par environnement (développement, préproduction, production)
• Une clé par application si vous exploitez plusieurs services
• Une rotation des clés au départ d'un membre de l'équipe

Réponses d'erreur