Aller au contenu principal

Introduction

YesWeCheck vérifie une adresse email et rend un verdict exploitable : peut-on lui écrire, et à quel risque ? Chaque validation enchaîne une série de contrôles (syntaxe, DNS, adresse jetable, faute de frappe, domaine piège, compte générique, dialogue SMTP…) et renvoie le détail de chacun.

Trois façons d'intégrer​

Ce qui est accessible par clé API​

L'API publique, celle qu'un serveur appelle avec une clé ywc_live_…, couvre la validation et les aides à la saisie :

EndpointRôleAuthentification
POST /v2/email/validateValider une adresseClé API
POST /v2/email/enrichDéduire prénom, nom, genre, âge présuméClé API
POST /v2/email/suggest/localpartProposer des parties locales à partir d'un nomClé API
POST /v2/email/suggest-firstname · suggest-lastnameAutocompléter un prénom, un nomClé API
GET /v2/email/suggest/domain/countriesPays couverts par les suggestions de domaineClé API
POST /v2/email/suggest/domainAutocompléter un domaine (gmail.com, orange.fr…)Aucune
POST /v2/email/suggest/typo-domainDétecter une faute de frappe dans le domaineAucune
GET /v2/billing/catalogPlans et packs de crédits, prix HTAucune
GET /healthÉtat de l'APIAucune

Le détail de chaque endpoint est dans la référence API.

Ce qui se gère depuis le tableau de bord

La création des clés API, le traitement par lots, les widgets, les listes blanche et noire, les politiques de validation et la facturation se pilotent depuis app.yeswecheck.fr. Leurs routes HTTP n'acceptent qu'une session du tableau de bord : une clé API y reçoit 401. Elles ne font donc pas partie de l'API publique documentée ici.

L'essentiel en cinq points​

  1. Une base d'URL : https://api.yeswecheck.fr/v2. Seuls /health et /status sont servis hors du préfixe /v2.
  2. Un en-tête : Authorization: Bearer ywc_live_…. L'en-tête X-API-Key n'est pas lu. Voir Authentification.
  3. Le SMTP se règle sur la clé, pas dans la requête : une clé créée avec le SMTP activé l'exécute à chaque appel, une clé sans SMTP ne l'exécute jamais. Voir Contrôles.
  4. Un crédit n'est débité que si le SMTP était activé et que le verdict final n'est pas unknown. Les autres contrôles sont gratuits. Voir Crédits.
  5. Le verdict est dans result (valid, risky, invalid, unknown), accompagné d'un score de 0 à 100. Voir Verdicts et score.

Liens utiles​

Tableau de bordapp.yeswecheck.fr
Statut de la plateformestatus.yeswecheck.fr
Spécification OpenAPIdocs.yeswecheck.fr/openapi.yaml
Support[email protected]