Skip to main content
A API da Lazy Data permite integrar consultas, validações, monitoramentos, enriquecimentos, armazenamento e histórico aos seus próprios sistemas. Esta seção reúne os conceitos básicos que valem para as requisições da API, como autenticação, ambiente de teste, padrão de resposta e tratamento de erros.

Antes de começar

Obtenha sua chave de API no painel, configure permissões e prepare sua primeira integração.

​
Primeiros passos

Obter credenciais

Veja onde criar e gerenciar suas chaves de API no painel da Lazy Data.

Autenticação

Entenda como enviar o token no header Authorization e autenticar suas requisições.

Ambiente de teste

Use x-ambient: sandbox para validar integrações sem consumir saldo da conta.

Códigos de erro

Consulte o padrão de erro da API e como tratar falhas de validação, saldo, plano ou provedor.

​
Autenticação

Todas as rotas protegidas usam autenticação via Bearer token. Envie sua chave de API no header:
Não envie a chave em query string, corpo da requisição, logs públicos ou aplicações frontend sem backend intermediário.
Para mais detalhes, consulte Autenticação.

​
Ambiente de teste

Alguns endpoints aceitam chamadas de teste por meio do header:
Quando esse header é aceito, a API retorna uma resposta simulada ou controlada sem consumir saldo da conta.

Ver regras do sandbox

Consulte quais funcionalidades aceitam teste e como validar integrações com segurança.

​
Padrão de resposta

As respostas da API seguem o contrato base:

​
Erros

Erros também seguem o mesmo contrato base:

Códigos de erro

Veja como identificar e tratar erros de autenticação, plano, saldo, parâmetros e provedores.

​
Boas práticas

  • Use uma credencial por aplicação, ambiente ou integração crítica.
  • Habilite restrição de IP quando a integração usar servidores com origem previsível.
  • Use sandbox para validar payloads antes de executar chamadas reais.
  • Não armazene documentos, imagens ou retornos sensíveis em logs sem necessidade.
  • Trate 401 e 403 separadamente: 401 indica falha de autenticação; 403 indica bloqueio de permissão, plano, IP, saldo ou política.
  • Em chamadas assíncronas, persista o id retornado para consultar o resultado posteriormente.

​
Próximo passo

Criar e usar sua credencial

Comece criando sua chave de API e configurando os escopos necessários para a integração.