Pular para o conteúdo

Autenticação

Toda requisição à API leva uma chave de API. As requisições nunca são associadas a uma sessão de navegador.

Criar uma chave de API

Crie chaves em Chaves de API, na sua conta, até 5. Você pode copiar uma chave nessa página a qualquer momento enquanto estiver conectado: nós a guardamos criptografada e a mostramos só para você. Mantenha-a em segredo, como uma senha, e, se ela pode ter sido vista, revogue-a e crie outra.

Enviar a chave de API

Envie-a no cabeçalho Authorization como Bearer seguido da chave. X-API-Key também funciona.

curl "https://api.talismanleads.io/v1/account" \
  -H "Authorization: Bearer tl_live_your_key_here"

O que uma chave de API pode fazer

Uma chave nova pode fazer tudo: ver seu saldo, os verificadores, seus pedidos e os resultados deles, e usar POST /uploads, POST /estimates e POST /orders, que guardam sua lista ou gastam seu saldo. Uma chave criada antes de 8 de novembro de 2026 pode ser somente leitura: ela pode ver tudo, mas essas três chamadas a recusam com missing_scope.

Validade e endereços IP

Uma chave nova nunca expira e funciona de qualquer endereço. Uma chave criada antes de 8 de novembro de 2026 pode ter uma data de validade, depois da qual é recusada com expired_key, ou estar restrita aos endereços IP do seu servidor, de modo que uma requisição de qualquer outro lugar é recusada com ip_not_allowed. Para mudar qualquer um dos dois, crie uma chave nova e revogue a antiga.

Manter uma chave de API segura

  • Trate uma chave como uma senha: qualquer pessoa que a tenha pode gastar seu saldo.
  • Use-a apenas no seu servidor. A API não permite chamadas de uma página web.
  • Mantenha-a fora do seu código e do seu controle de versão.
  • Se uma chave pode ter sido vista, revogue-a na sua conta imediatamente. Ela para de funcionar na hora. Pedidos já feitos continuam em execução.
  • Envie-a apenas para a API. Os links de upload e download têm sua própria permissão, então não envie sua chave para eles.

Quando uma chave de API é recusada

Com uma chave errada, revogada ou expirada, a resposta é 401. Com uma chave ou conta bloqueada, a resposta é 403. Veja Erros.

Nesta página