L'API REST de Mailbeam vit sur https://api.mailbeam.dev, tous ses endpoints étant sous /v1/. Les requêtes s'authentifient par un jeton Bearer, envoient et reçoivent du JSON, et renvoient le résultat directement, sans enveloppe : les erreurs sont les seules réponses emballées, et portent un code d'erreur, un message et un request_id.
- URL de base
- https://api.mailbeam.dev/v1/
- En-tête d'authentification
- Authorization: Bearer mb_live_…
- Type de contenu
- application/json
- Champs d'erreur
- error · message · request_id
Référence de l'API
L'API REST de Mailbeam vous permet de vérifier des adresses e-mail, de lancer des tâches par lots et de suivre la consommation de votre compte.
URL de base
https://api.mailbeam.dev
Tous les endpoints se trouvent sous /v1/. Les changements incompatibles arriveront dans de nouvelles versions (/v2/, etc.).
Authentification
Toute requête exige un jeton Bearer dans l'en-tête Authorization :
Authorization: Bearer mb_live_xxxxxxxxxxxxxxxxxxxxVoyez Authentification pour les types de clé, la rotation et le mode test.
Type de contenu
Une requête qui porte un corps doit envoyer Content-Type: application/json. Toutes les réponses renvoient Content-Type: application/json.
Versionnage
La version actuelle de l'API est v1. Nous tenons la compatibilité ascendante à l'intérieur d'une version. Quand un changement incompatible s'impose, nous ouvrons une nouvelle version et déprécions l'ancienne avec au moins 12 mois de préavis.
Idempotence
L'endpoint POST /v1/verify se réessaye sans risque : il n'a pas d'effet de bord. L'appeler deux fois pour la même adresse renvoie le même résultat, aux variations de temps et de réseau près.
Pour POST /v1/verify/batch, servez-vous de l'en-tête Idempotency-Key pour réessayer un envoi sans créer de tâche en double :
Idempotency-Key: your-unique-job-idEnveloppe de réponse
Toute réponse réussie renvoie le résultat directement, sans enveloppe. Une erreur renvoie :
{
"error": "error_code",
"message": "Human-readable description.",
"request_id": "req_01hx9abc123"
}Endpoints
| Méthode | Chemin | Description |
|---|---|---|
POST | /v1/verify | Vérifier une adresse |
POST | /v1/verify/batch | Envoyer un lot d'adresses |
GET | /v1/jobs/:id | Interroger l'état d'une tâche par lots |
GET | /v1/account/usage | Consulter la consommation du quota |
Questions fréquentes
Réponses vérifiées sur le contrat de l'API le .