Páginas da documentação

Desenvolvedores · Guia · v1.2.0

Autenticação e agências

Como criar o token, os escopos e como agências operam cada cliente.

https://leadgo.com.br/api/v1 Baixar arquivo para IA OpenAPI 3.1 Criar token

Autenticação

Crie o token no painel, em API (menu Configurações). É preciso ser administrador da conta. O token aparece uma única vez: guarde-o num cofre de senhas ou nas variáveis de ambiente do seu sistema, nunca no front-end. Envie-o em todas as chamadas:

Cabeçalho
Authorization: Bearer lgo_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Cada token opera uma única conta, em nome de quem o criou: o token nunca faz mais do que essa pessoa faria no painel. Se ela sair da conta ou perder a permissão, o token para (token_owner_lost_access). Escolha só os escopos de que a integração precisa:

Escopo Permite
campaigns:read Ler campanhas e consultas: Conta de anúncio (saúde, saldo e alertas), campanhas, conjuntos, anúncios, públicos, personas, padrões, segmentação e listas de referência.
campaigns:write Criar e alterar campanhas: Publicar, pausar, ativar, mudar verba, duplicar e excluir campanhas, conjuntos e anúncios; criar públicos, personas e padrões.
media:write Enviar mídias: Subir imagens e vídeos para os anúncios.
reports:read Ler métricas: Resultados e gastos da conta, das campanhas e dos anúncios.
ai:draft Rascunho pela IA: Montar uma campanha a partir de um briefing e sugerir personas.
webhooks:manage Gerenciar webhooks: Cadastrar URLs que recebem os avisos das campanhas, dos leads e do Gestor IA.
account:manage Gerenciar a conta de anúncio: Limite de gasto da conta de anúncio e alertas.
leads:read Ler leads: Leads dos formulários, com as respostas, o contato e o histórico (dados pessoais).
leads:write Atualizar leads: Mudar o status do lead, registrar venda ou perda, notas e exclusão (LGPD).
brain:read Ler o Gestor IA: Relatórios e ações propostas pelo Gestor IA.
brain:manage Decidir no Gestor IA: Pedir análise, aprovar, recusar e desfazer ações do Gestor IA.
  • Até 10 tokens ativos por conta: use um por integração e revogue só o que vazar.
  • Validade de 30 dias, 90 dias, 1 ano ou sem validade. Token vencido responde token_expired.
  • Teste com GET /me: ele diz a conta, o autor e os escopos do token.
  • A conta precisa estar ativa e em dia. Com fatura vencida além da carência, as chamadas respondem 402 (payment_overdue).

Agências e clientes

Gestores e agências criam um token por cliente: no painel, entre na conta do cliente (Clientes › Operar) e crie o token na tela API. Esse token só enxerga e opera aquele cliente: campanhas, mídias, webhooks e métricas ficam separados por conta, como no painel.

O token é da pessoa da agência que o criou. Se o cliente deixar de ser gerenciado pela agência, o token para de funcionar.