Referência para desenvolvedores

Cabeçalhos de requisição

Todas as solicitações de API requerem autenticação. Cadastre-se gratuitamente para obter sua chave de API e 10.000 créditos mensais.

Cabeçalhos de requisição

Todas as solicitações de API requerem autenticação. Cadastre-se gratuitamente para obter sua chave de API e 10.000 créditos mensais.

  • Content-Type: application/json (obrigatório para pedidos POST)
  • Accept: application/json (opcional mas recomendado)
  • X-API-Key: A sua chave de API (obtenha uma gratuitamente em /dashboard)
  • Authorization: Bearer your-api-key (alternativa a X-API-Key)
  • Idempotency-Key: opcional, em requisições POST que cobram créditos. Repetir com a mesma chave e uma requisição idêntica em até 24 horas retorna a resposta armazenada com Idempotent-Replayed: true e não cobra nada novamente. Reutilizar uma chave em uma requisição diferente retorna 422 IDEMPOTENCY_KEY_REUSED, e um duplicado enviado enquanto a primeira requisição ainda está em andamento retorna 409 IDEMPOTENCY_IN_PROGRESS. Respostas maiores que 1 MiB e erros reembolsados não são armazenados, então uma nova tentativa é executada normalmente. As chaves têm de 1 a 255 caracteres ASCII imprimíveis, como um UUID.
  • DomScan-Naming: opcional. snake devolve todas as chaves camelCase da resposta em snake_case, o mesmo que naming=snake. Quando ambos são enviados, o parâmetro de consulta prevalece. Consulte chaves snake_case.