API Pública — tokens e escopos
Como gerar tokens de acesso à API do AxDeal e quais dados você pode consultar ou enviar.
Data: 25/06/2026·Atualização: 25/06/2026
API Pública — tokens e escopos
A API pública do AxDeal permite que sistemas externos leiam e gravem dados sem precisar fazer login na interface.
Gerar um token
- Acesse Configurações → Integrações & API → API Tokens.
- Clique em "+ Gerar Token".
- Selecione os escopos (permissões do token):
| Escopo | Acesso |
|---|---|
financeiro:read | Leitura de parcelas, categorias, contas |
financeiro:write | Criar/editar lançamentos |
contatos:read | Leitura de clientes |
contatos:write | Criar/editar clientes |
agenda:read / write | Agendamentos |
relatorios:read | Relatórios e KPIs |
- Escolha o ambiente:
live(produção) outest(sandbox). - Defina uma expiração (opcional) e o rate limit.
- Copie o token na hora — ele é exibido apenas uma vez!
Ambientes
| Prefixo | Ambiente |
|---|---|
axd_live_... | Produção — afeta dados reais |
axd_test_... | Sandbox — para testes sem impacto |
Em construção: documentação completa dos endpoints REST disponível em breve.
Este artigo foi útil?