🔑 API Pública¶
A API Pública deixa você (ou seu time de desenvolvimento) ler e escrever dados do Atende Ágil a partir de outro sistema seu: enviar mensagens, consultar contatos, mover um negócio no funil, tudo por código. 👨💻
🔐 Autenticação¶
Toda chamada precisa do header x-api-key com sua chave de API. Gere a sua na aba Integrações, no card Chave de API (mesmo lugar dos Webhooks de Entrada), é o token usado pra conectar ferramentas como n8n, Typebot ou Zapier. Guarde essa chave como uma senha, ela dá acesso completo aos dados do seu workspace.
x-api-key: sua-chave-aqui
🔄 Gerar uma chave nova invalida a anterior
O botão Gerar Nova Chave substitui a chave atual na hora, qualquer integração que ainda estiver usando a chave antiga para de funcionar imediatamente. Atualize todos os lugares que usam a chave antes de gerar uma nova.
📚 O que dá pra fazer¶
- Mensagens: enviar uma mensagem de texto pra um contato.
- Contatos: consultar, criar ou atualizar contatos.
- Etiquetas (tags): adicionar ou remover etiquetas de um contato.
- Funil: consultar pipelines/etapas e mover um negócio de etapa.
- Negócios (deals): criar e consultar negócios vinculados a um contato.
- Fila do departamento: colocar um contato na fila de um departamento (
POST /v1/contact/queue, comphoneedepartment, que pode ser o nome ou o id do departamento). O contato fica sem responsável até alguém do setor aceitar. Veja Departamentos e fila.
📖 Documentação completa¶
A lista exata de endpoints, parâmetros e exemplos de resposta fica no Swagger, disponível em app.atendeagil.com/api-docs dentro do seu Atende Ágil. É sempre a fonte mais atualizada, novos endpoints aparecem lá assim que são lançados.
🧪 Teste direto no Swagger
A tela do Swagger permite testar cada endpoint direto do navegador, com sua chave de API, antes de escrever qualquer código. Ótimo pra validar o formato de resposta rapidinho.