Endpoints

A API do YesCaptcha tem dois endpoints, com métodos e parâmetros idênticos. Escolha conforme a localização do seu servidor:

Endpoint	Endereço	Indicado para
Endpoint global	https://api.yescaptcha.com	Servidores fora da China continental
Endpoint China	https://cn.yescaptcha.com	Servidores na China continental

A URL de um método é o endereço do endpoint mais o nome do método, por exemplo, para criar uma tarefa:

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

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

Regras

• Use apenas HTTPS.
• Todos os métodos, exceto /useragent, usam POST com corpo JSON e o cabeçalho Content-Type: application/json. O corpo da requisição não pode ultrapassar 6 MB.
• A autenticação é feita pela clientKey no corpo da requisição; nenhum outro cabeçalho é necessário.

Nota

Consulte a tarefa com getTaskResult no mesmo endpoint em que a criou. Não misture os dois endpoints.

Todos os métodos

Método	Função	Observações
createTask	Criar uma tarefa	Tipos síncronos retornam o resultado diretamente
getTaskResult	Consultar o resultado da tarefa	Nos tipos assíncronos, consulte a cada 5 segundos
getBalance	Consultar o saldo	Sem cobrança de pontos
getSoftID	Consultar o ID de desenvolvedor	Usado na participação do desenvolvedor
report	Reportar o resultado do reconhecimento	Tipos de reconhecimento de imagem podem solicitar reembolso de pontos após reportar
useragent	Obter o User-Agent recomendado	GET, usado com hCaptcha

Se não conseguir se conectar à API, consulte Problemas de conexão e rede.