API V2
La version 2 de l'API Captain Verify est désormais disponible et elle comporte de nouvelles fonctionnalités. Si vous cherchez un moyen fiable de vérifier la validité de vos emails, vous pouvez intégrer l'API de vérification des emails de Captain Verify dans vos propres applications.
Clé API
Un compte est nécessaire pour générer la clé pour l'API, c'est ce qui vous donnera accès au service.
Limites de l'API
L'API est limitée à un maximum de 2 connexions simultanées et 50 vérifications par minute. Lorsque vous intégrez l'API, assurez-vous que votre application ne dépasse pas cette limite.
La requête
Pour faire une demande à l'API, appelez simplement le protocole GET à cette URL :
https://api.captainverify.com/v2/verify?apikey=XXXXXXXXXXXXXXXXXXXX&email=john.doe@gmail.com
Remplacez john.doe@gmail.com par votre email pour vérifier.
La réponse
Une table json sera renvoyée avec ces variables:
{
"credits":870,
"result":"invalid",
"details":"unknown_email",
"free":true,
"role":false,
"disposable":false,
"ok4all":false,
"protected":false,
"did_you_mean":"john.doe@gmail.com",
"email":"john.doe@gmail.com",
"email_normalized":"john.doe@gmail.com",
"success":true,
"message":null
}
| Variables | Valeur possible |
|---|---|
| credits | Crédits disponibles sur votre compte. |
| result | valid, invalid, risky, unknown Le statut de l'email. si tous vos crédits ont été épuisés, le statut inconnu sera toujours retourné, pour ne pas bloquer votre application. |
| details | null, email error, greylisting, low quality, low deliverability, mailboxfull... Comprendre le résultat d'une vérification. |
| free | true, false Si le fournisseur de messagerie est gratuit, ex : Gmail.com. |
| role | true, false Si l'utilisateur du courrier électronique a un rôle, ex: support@exemple.com. |
| disposable | true, false L'email est valide, mais jetable après une courte période il ne sera plus possible de contacter l'utilisateur. |
| ok4all | true, false Ok pour tout : le serveur de messagerie distant accepte tous les e-mails (catch-all). |
| protected | true, false L'email est protégé par une solution antispam propriétaire |
| mailboxfull | true, false L'adresse e-mail est pleine. Elle ne peut plus recevoir de courrier |
| did_you_mean | default : null Si par exemple, le courrier électronique est john.doe@gmil.com, l'API vous enverra une proposition comme john.doe@gmail.com. |
| L'email que vous souhaitez vérifier. | |
| email_normalized | L'email a normalisé, l'élimination des étiquettes pour gmail ... support+test@gmail.com sera support@gmail.com. |
| success | true, false Si l'authentification a échoué, l'épuisement de vos crédits. |
| message | default : null Lorsque le succès est faux, un message d'erreur sera envoyé. |