PARA QUEM CONSTRÓI

Seu código.
Um novo fluxo.

Conheça a proposta de integração e prepare sua aplicação para a API.

Contrato proposto. Endpoints, parâmetros e respostas precisam ser confirmados com a equipe da API antes do uso real.

Primeiros passos

A integração está organizada em três etapas: identificar sua aplicação, criar uma tarefa e acompanhar seu resultado. Use o painel demonstrativo para conhecer a experiência.

1Obtenha uma credencial no serviço real
2Crie uma tarefa com o tipo e os parâmetros
3Consulte o resultado pelo identificador

Autenticação

A proposta usa uma credencial clientKey nas chamadas do servidor. A chave deve permanecer em variáveis de ambiente, fora do código público e do navegador. As chaves do painel demo não acessam serviços.

Criar uma tarefa

POST /createTask

Envie a credencial e os parâmetros necessários para o tipo escolhido.

// Contrato proposto — configure a URL da API real no servidor
const response = await fetch(API_BASE_URL + "/createTask", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({
    clientKey: process.env.SOLUCAPTCHA_API_KEY,
    task: {
      type: "RecaptchaV2Task",
      websiteURL: "https://sua-aplicacao.com",
      websiteKey: "SUA_SITE_KEY"
    }
  })
});
if (!response.ok) throw new Error("Falha ao criar tarefa");
const task = await response.json();

Resposta esperada

{
  "errorId": 0,
  "taskId": "example-task-id"
}

Consultar o resultado

POST /getTaskResult

Use o taskId para consultar o estado. Se estiver em processamento, aguarde antes de consultar novamente, respeitando os intervalos e limites definidos pela API.

{
  "clientKey": "SUA_CHAVE_NO_SERVIDOR",
  "taskId": "example-task-id"
}

Estados e erros

ready

A tarefa tem um resultado disponível.

processing

A tarefa continua em processamento.

error

Verifique o código e a descrição do erro retornado.

Trate credenciais inválidas, saldo insuficiente, respostas inesperadas e tempo limite. A nomenclatura final dos erros será definida pela API.

Precisa de ajuda para integrar?