FAQ - Perguntas Frequentes sobre a API da Conta Azul
Este FAQ reĆŗne as principais dĆŗvidas de desenvolvedores que integram seus sistemas com a API da Conta Azul.
š Autenticação e Autorização
Como faço a autenticação na API da Conta Azul?
A autenticação é feita via OAuth 2.0. Você deve:
- Redirecionar o usuÔrio para a URL de autorização.
- Trocar o código de autorização por um token de acesso.
- Usar o token de acesso para chamadas autenticadas.
Consulte o guia de autenticação.
Qual o tempo de expiração do código de autorização obtido?
O código de autorização tem validade de 3 minutos. Desta forma após obter o código você terÔ 3 minutos para realizar a troca por um token de acesso.
š Como gerar o valor em Base64 para autenticação?
Para autenticar sua requisição ao endpoint https://auth.contaazul.com/oauth2/token
, vocĆŖ precisa enviar o header:
Authorization: Basic BASE64(client_id:client_secret)
š¹ Como gerar o valor em Base64:
Junte o
client_id
e oclient_secret
com:
no meio.
Exemplo:abc123:xyz456
Codifique esse valor em Base64.
Resultado (exemplo):YWJjMTIzOnh5ejQ1Ng==
Envie no header da requisição:
Authorization: Basic YWJjMTIzOnh5ejQ1Ng==
š§ Formas de gerar o valor codificado:
Ferramenta online:
https://www.base64encode.orgLinux/macOS terminal:
echo -n "client_id:client_secret" | base64
- Windows PowerShell:
[Convert]::ToBase64String([Text.Encoding]::UTF8.GetBytes("client_id:client_secret"))
Como conectar meu aplicativo a mĆŗltiplos clientes (empresas Conta Azul)?
Você deve repetir o fluxo de autorização de OAuth para cada empresa que desejar integrar. Cada autorização gera um token exclusivo por empresa
A API tem limite de requisiƧƵes?
Sim. A Conta Azul aplica rate limits nas integrações. Os detalhes do limite devem ser tratados via headers da resposta HTTP. Hoje nossos limites são: 50 chamadas por minuto e até 10 por segundo.
Existe webhook para receber eventos da Conta Azul?
Ainda nĆ£o estĆ” disponĆvel nativamente. VocĆŖ pode simular esse comportamento criando um polling recorrente nos endpoints.
Existe ambiente de homologação ou sandbox?
Não. Ao criar um APP o desenvolvedor tem acesso a uma conta trial com duração de 30 dias.
VocĆŖ pode realizar testes com nosso servidor "Mock" aqui mesmo no portal do desenvolvedor.