Démarrer en 5 minutes
Ce guide vous amène de zéro à votre premier appel API en 5 étapes.
Étape 1 — Obtenir une clé API
- Créez votre compte sur app.yeswecheck.fr (gratuit, sans CB)
- Depuis le Dashboard → Settings → API Keys → Créer une nouvelle clé
- Donnez un nom à votre clé (ex:
Production), configurez les options si besoin - Copiez la clé immédiatement — elle ne sera plus affichée
ywc_live_abc123xyz789...
Stockage sécurisé
Ne committez jamais votre clé API dans votre dépôt Git. Utilisez des variables d'environnement :
YESWECHECK_API_KEY=ywc_live_abc123xyz789...
Étape 2 — Valider votre premier email
- cURL
- JavaScript
- Python
- PHP
curl -X POST https://api.yeswecheck.fr/v2/email/validate \
-H "X-API-Key: ywc_live_votre_cle_ici" \
-H "Content-Type: application/json" \
-d '{"email": "[email protected]"}'
const response = await fetch('https://api.yeswecheck.fr/v2/email/validate', {
method: 'POST',
headers: {
'X-API-Key': process.env.YESWECHECK_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify({ email: '[email protected]' }),
});
const result = await response.json();
console.log(result.status); // "valid"
console.log(result.score); // 95
import requests
response = requests.post(
"https://api.yeswecheck.fr/v2/email/validate",
headers={
"X-API-Key": "ywc_live_votre_cle_ici",
"Content-Type": "application/json",
},
json={"email": "[email protected]"},
)
result = response.json()
print(result["status"]) # valid
print(result["score"]) # 95
$ch = curl_init('https://api.yeswecheck.fr/v2/email/validate');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
'X-API-Key: ' . getenv('YESWECHECK_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode(['email' => '[email protected]']),
]);
$result = json_decode(curl_exec($ch), true);
echo $result['status']; // valid
Réponse :
{
"email": "[email protected]",
"status": "valid",
"score": 95,
"syntax": { "valid": true, "normalized": "[email protected]" },
"dns": { "hasMxRecords": true, "mxRecords": ["gmail-smtp-in.l.google.com"] },
"disposable": { "isDisposable": false },
"roleAccount": { "isRoleAccount": false },
"typo": { "hasTypo": false, "suggestions": [] },
"randomDetection": { "isRandom": false, "confidence": 0.03 },
"smtp": { "performed": false },
"metadata": {
"creditsUsed": 0,
"processingTimeMs": 187,
"apiVersion": "v2"
}
}
Étape 3 — Interpréter le résultat
Le champ status
| Statut | Signification | Action recommandée |
|---|---|---|
valid | Email valide et délivrable | ✅ Accepter |
invalid | Email invalide (syntaxe, domaine, SMTP rejeté) | ❌ Refuser |
risky | Email existant mais à risque (jetable, role, random) | ⚠️ Avertir ou refuser |
unknown | Impossible de vérifier (timeout SMTP, greylist) | 🟡 Accepter avec prudence |
Le champ score
Un score de 0 à 100 résume la qualité globale :
- 90-100 : Excellent — email valide et de qualité
- 60-89 : Bon — quelques signaux de risque mineurs
- 30-59 : Risqué — présence de signaux négatifs
- 0-29 : Invalide — email inutilisable
Étape 4 — Activer la vérification SMTP
La vérification SMTP confirme que la boîte aux lettres existe réellement. Elle consomme 1 crédit par email.
curl -X POST https://api.yeswecheck.fr/v2/email/validate \
-H "X-API-Key: ywc_live_votre_cle_ici" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"smtp": true,
"smtpTimeout": 8000
}'
{
"status": "valid",
"smtp": {
"performed": true,
"deliverable": true,
"responseCode": 250,
"responseMessage": "OK"
},
"metadata": {
"creditsUsed": 1,
"creditsRemaining": 499
}
}
Étape 5 — Vérifier votre solde de crédits
curl https://api.yeswecheck.fr/v2/credits/balance \
-H "X-API-Key: ywc_live_votre_cle_ici"
{
"balance": 498,
"lastUpdated": "2025-01-15T10:30:00Z"
}