Pular para o conteúdo principal

Integração por chave de API

Outros sistemas da ATLA (por exemplo, o marketplace) usam o ATLA Link sem um usuário, com uma chave de API. A chave é gerada pelo admin ATLA em Chaves de API.

Como a chave funciona​

  • A chave identifica o sistema, não uma pessoa. Ela age com um papel próprio, de serviço, com permissões limitadas.
  • O sistema envia a chave em um cabeçalho HTTP próprio para chaves de API, em toda chamada. O nome do cabeçalho é informado pela ATLA junto com a chave.
  • A chave completa é mostrada uma única vez, quando é gerada. Guarde-a em um cofre de senhas ou no armazenamento seguro do sistema que vai usá-la; nunca em código, planilha ou mensagem.
  • A chave pode ter validade. Chave expirada ou revogada para de funcionar na hora.
  • Cada uso fica registrado (último uso aparece na lista de chaves), e ações como criar subconta entram na auditoria.

O que a chave pode fazer​

PodePara quê
Criar subcontaAbrir a conta de pagamento de um cliente do sistema integrado.
Consultar subconta e situação da análiseAcompanhar a abertura da conta (etapa e situação).
Pedir o encerramento de uma subcontaQuando o cliente deixa o sistema integrado.
Consultar a conta raizLer os dados da conta principal da ATLA.
Criar e consultar cobranças de checkoutCobrar compras do marketplace. Veja Checkout.

O que a chave não pode fazer​

A chave não envia Pix ou TED, não estorna, não lê clientes, cobranças, extrato nem assinaturas das subcontas, não gerencia usuários, equipe nem outras chaves, e não troca senha nem usa a verificação em duas etapas. Uma integração que precise de mais recebe um escopo próprio, combinado com a ATLA.

Veja a tabela completa em Rotas e permissões.

Boas práticas​

  • Uma chave por sistema e por ambiente (produção e testes separados), com nome que diga onde é usada.
  • Defina validade quando a integração for temporária.
  • Ao suspeitar de vazamento, revogue a chave e gere outra.