Skip to content
Last updated

🌐 Introdução às APIs Conta Azul

As APIs da Conta Azul permitem integrar sistemas externos ao ERP Conta Azul de forma segura, padronizada e escalável.
Elas oferecem recursos para automatizar processos financeiros, vendas, cadastros de clientes e fornecedores, produtos e notas fiscais, facilitando a sincronização de dados.


🚀 O que você pode fazer com nossas APIs

Com as APIs Conta Azul, é possível:

  • Integrar sistemas parceiros (BI, CRM, e-commerce, etc.);
  • Automatizar lançamentos de contas a pagar e receber;
  • Consultar informações financeiras e contábeis em tempo real;
  • Criar e manter cadastros de clientes, produtos e serviços sempre atualizados;
  • Consultar notas fiscais eletrônicas (somente produtos NFe) - Em breve Serviços (NFS-e)

🧭 Estrutura Geral das APIs

A documentação das APIs Conta Azul está organizada por áreas funcionais.
Abaixo, você encontra uma visão geral com o propósito de cada uma e links diretos para os respectivos guias técnicos.

ÁreaDescriçãoExemplo de UsoLink
🔐 AutenticaçãoAPIs para autenticação via OAuth2, geração de credenciais e acesso a metadados.Criar uma aplicação e obter tokens de acesso às APIs.Ver documentação
💰 Financeiro / Cobranças / BaixasControle completo de contas a pagar e receber, baixas, conciliações, cobranças e despesas.Automatizar a baixa de títulos e conciliação de pagamentos.Ver documentação
🧾 VendasCriação, atualização e consulta de vendas.Criar uma venda e replicar automaticamente na Conta Azul.Ver documentação
👥 Pessoas / FornecedoresCadastro e consulta de clientes, fornecedores .Sincronizar automaticamente clientes entre sistemas.Ver documentação
📦 Produtos e ServiçosGerenciamento de produtos e serviços: criação, atualização, estoque e valores.Integrar catálogo de produtos do e-commerce com o ERP.Ver documentação
🧮 Notas FiscaisConsulta de notas fiscais vinculadas a vendas de produtos.Consultar NFe emitidasVer documentação
📑 ContratosGestão de contratos recorrentes.Controlar contratos mensais e alocar despesas por centro de custo.Ver documentação

⚙️ Padrões Técnicos

  • Estilo: REST
  • Formato: JSON
  • Autenticação: OAuth 2.0
  • Códigos de retorno: HTTP padrão (200, 400, 401, 404, 429, 500)
  • Paginação: parâmetros page e size
  • Data/hora: formato ISO 8601 (YYYY-MM-DDTHH:mm:ssZ)

Futuro da API

No momento, algumas funcionalidades importantes ainda não estão disponíveis. Estamos constantemente trabalhando para aprimorar e expandir nossas capacidades, mas é importante que você esteja ciente das seguintes características atuais:

  • Ambiente de Homologação (Sandbox): não oferecemos um ambiente de sandbox dedicado. Para testes, você terá acesso a uma conta do desenvolvedor com duração de 30 dias, que pode ser estendida se necessário. Esta conta permite que você valide suas integrações em um ambiente realista
  • Webhooks: atualmente, a API não suporta webhooks, portanto, sua aplicação não receberá notificações automáticas sobre eventos ou mudanças de dados. Para manter seus dados atualizados, será preciso implementar um mecanismo de polling (consultas periódicas à API)
  • SDKs Oficiais: não dispomos de Software Development Kits (SDKs) oficiais para linguagens de programação. Sua integração deverá ser construída diretamente com chamadas HTTP e manipulação de JSON, sem o auxílio de bibliotecas pré-prontas específicas da Conta Azul

Fale Conosco

Para eventuais dúvidas, a documentação é a sua melhor fonte. Recomendamos a leitura das guias de “OAuth 2.0”, “Guias de Uso” e “Erros Comuns”. Caso enfrente bugs ou indisponibilidades, por favor, entre em contato com o suporte pelo e-mail api@contaazul.com . Além disso, você também pode acessar o Chat pelo Portal do Desenvolvedor para tirar dúvidas e obter orientações sobre o uso das APIs.