Начало работы

Адреса доступа

Эта страница переведена с китайской версии машинным переводом и может содержать ошибки. Приоритет имеет китайская версия.

У API YesCaptcha два endpoint с одинаковыми методами и параметрами. Выберите тот, что ближе к вашим серверам:

Endpoint	Адрес	Для чего
Глобальный	`https://api.yescaptcha.com`	Серверы за пределами материкового Китая
Для Китая	`https://cn.yescaptcha.com`	Серверы в материковом Китае

URL метода — это адрес endpoint плюс имя метода, например для создания задачи:

POSThttps://api.yescaptcha.com/createTaskГлобальный endpoint

POSThttps://cn.yescaptcha.com/createTaskEndpoint для Китая

Правила

Только HTTPS.
Все методы, кроме /useragent, используют POST с телом в формате JSON и заголовком Content-Type: application/json. Размер тела не должен превышать 6 MB.
Аутентификация выполняется по clientKey в теле запроса; другие заголовки не нужны.

Метод	Назначение	Примечания
createTask	Создать задачу	Синхронные типы сразу возвращают результат
getTaskResult	Получить результат задачи	Для асинхронных типов опрашивайте (polling) каждые 5 секунд
getBalance	Узнать баланс	Баллы не списываются
getSoftID	Узнать ID разработчика	Для доли разработчика
report	Сообщить о неверном результате	Для типов распознавания изображений возможен возврат баллов после жалобы
useragent	Получить рекомендуемый User-Agent	`GET`, используется с hCaptcha

Если не удаётся подключиться, см. Проблемы с подключением и сетью.