Endpoints

L’API YesCaptcha propose deux endpoints dont les méthodes et les paramètres sont identiques. Choisissez celui qui correspond à l’emplacement de vos serveurs :

Endpoint	Adresse	À utiliser pour
Endpoint mondial	https://api.yescaptcha.com	Serveurs hors de Chine continentale
Endpoint Chine	https://cn.yescaptcha.com	Serveurs en Chine continentale

L’URL d’une méthode est l’adresse de l’endpoint suivie du nom de la méthode, par exemple pour créer une tâche :

POSThttps://api.yescaptcha.com/createTaskEndpoint mondialCopier

POSThttps://cn.yescaptcha.com/createTaskEndpoint ChineCopier

Règles

• HTTPS uniquement.
• Toutes les méthodes, sauf /useragent, utilisent POST avec un corps JSON et l’en-tête Content-Type: application/json. Le corps de la requête ne doit pas dépasser 6 MB.
• L’authentification se fait avec le clientKey dans le corps de la requête ; aucun autre en-tête n’est nécessaire.

Note

Interrogez une tâche avec getTaskResult sur le même endpoint que celui où vous l’avez créée. Ne mélangez pas les deux endpoints.

Toutes les méthodes

Méthode	Rôle	Remarques
createTask	Créer une tâche	Les types synchrones renvoient directement le résultat
getTaskResult	Obtenir le résultat d’une tâche	Pour les types asynchrones, interrogez toutes les 5 secondes
getBalance	Consulter le solde	Sans débit de points
getSoftID	Obtenir votre ID développeur	Pour la part développeur
report	Signaler un résultat	Les types de reconnaissance d’images peuvent donner lieu à un remboursement après signalement
useragent	Obtenir le User-Agent recommandé	GET, utilisé avec hCaptcha

Si vous n’arrivez pas à vous connecter, consultez Problèmes de connexion et de réseau.