Início › Funcionalidades › API pública
API pública
API pública
Endpoints de leitura para listar seus clientes e suas cobranças a partir do seu próprio sistema, com chave de acesso que você gera e revoga.
A API pública do FinanceiroAI permite que o seu próprio sistema consulte os seus dados. Hoje ela expõe dois recursos, clientes e cobranças, ambos somente para leitura. O acesso é por chave, gerada por você dentro do FinanceiroAI e revogável a qualquer momento, enviada no cabeçalho de autorização da requisição. A documentação é pública e está em financeiro.ai/api-docs, com os campos de resposta e exemplos. Emitir, alterar ou cancelar cobrança pela API ainda não é possível: essas ações acontecem no FinanceiroAI.
Incluído na Assinatura de R$ 99/mês
O que você tem
- Clientes e cobranças: Dois endpoints de leitura, com os campos que você já vê nas telas.
- Chaves que você controla: Gere quantas precisar e revogue quando quiser, sem falar com a gente.
- Documentação aberta: Campos, exemplos e formato de resposta em financeiro.ai/api-docs, sem precisar de conta para ler.
Como funciona
- Gere a chave: Nas integrações do FinanceiroAI. Ela aparece uma vez, então guarde num lugar seguro.
- Chame os endpoints: Com a chave no cabeçalho de autorização. A documentação traz os exemplos prontos.
- Revogue quando precisar: Chave comprometida ou fornecedor que saiu: revogar corta o acesso na hora.
O que não faz
- Não cria, altera nem cancela cobrança: os endpoints de hoje são somente de leitura.
- Não envia mensagem pelo Agente Financeiro por chamada de API.
Perguntas frequentes
Consigo emitir cobrança pela API?
Ainda não. A API pública de hoje expõe dois recursos de leitura, clientes e cobranças, para você trazer esses dados para dentro do seu sistema. A emissão continua acontecendo no FinanceiroAI, seja avulsa, recorrente ou em lote. A documentação em financeiro.ai/api-docs sempre reflete o que está disponível no momento.