Aviso: A versão clássica da Conta Azul deixou de ser comercializada. Para melhor atender os donos de negócio e contadores, empresas que já usavam a versão Clássica podem permanecer nela. Novas assinaturas obrigatoriamente devem usar a versão Pro. Para saber mais clique aqui.
Pergunta Frequente

FAQ API | Dúvidas mais comuns para desenvolvedores

Bruna Schmitz
Bruna Schmitz
- Atualizado

Além da possibilidade de integrar com outros aplicativos através das integrações diretas, indiretas e da Pluga, a Conta Azul possui API aberta, para que caso deseje, junto à um desenvolvedor, você possa criar a integração com o seu sistema ou aplicativo.


Qual é o formato utilizado para integrar com outras soluções do mercado?

Atualmente, possuímos diversas integrações nativas, como mencionamos neste artigo. Caso deseje criar uma integração entre o seu software e a Conta Azul, é possível criá-la através da nossa API.

 

O que fazer caso o aplicativo que eu quero não seja integrado à Conta Azul de forma nativa?

Neste caso, é possível desenvolver a integração baseando-se na API aberta da Conta Azul, que é disponibilizada nesta documentação. Além disso, temos um Portal de Ideias que você pode utilizar para sugerir funcionalidades e integrações que seriam importantes para você.

 

Qualquer pessoa pode construir essa integração?

Sim, pois a API é aberta e a documentação disponibilizada para todos os clientes. Porém, sugerimos que tenha um desenvolvedor de software que faça com você.

 

A API da Conta Azul é segura?

Sim. Nossa API utiliza o mesmo padrão de autenticação de empresas como a Google, Facebook e Amazon. Além disso, todos os dados ficam salvos na Amazon, que está de acordo com diversas normas de segurança de dados.

 

Quais os módulos que são disponibilizados para integração na API?

Através da API é possível criar, editar, listar e excluir as seguintes informações: produtos, serviços, clientes, fornecedores e vendas, além de criar e listar contratos (não é possível realizar edição ou exclusão de contratos por meio da API).

 

A Conta Azul tem uma base de testes para os desenvolvedores?

Não temos uma base de testes, apenas o ambiente de produção. Se você ainda não é nosso cliente  pode fazer a criação de uma conta teste no site da Conta Azul > Experimente grátis. Depois de feito este cadastro, já terá acesso a 3 dias de conta teste.

Caso não seja suficiente o período de degustação do nosso ERP, conseguimos disponibilizar uns dias extras para você realizar os testes necessários, é só enviar um e-mail para api@contaazul.com.

 

Como criar uma conta no portal de desenvolvedores?

Para criar uma conta no portal de desenvolvedores, é necessário acessar o link: https://portaldevs.contaazul.com/#/login/ e utilizar um e-mail em formato Gmail.

 

Como conectar minha conta da Conta Azul e minha conta no Portal do Desenvolvedor?

As suas contas na Conta Azul e no Portal do Desenvolvedor são completamente independentes, ou seja, não há necessidade de conectar as duas contas.

 

Existe alguma maneira de autenticação simplificada na API?

Não. Todos os passos necessários para realizar o acesso estão disponíveis nessa documentação. A autenticação precisa seguir esses passos por questões de segurança.

 

Como gerar o Access Token?

Para gerar o Access Token você precisa preencher o link com as informações na URI padrão: https://api.contaazul.com/auth/authorize?redirect_uri={REDIRECT_URI}&client_id={CLIENT_ID}&scope=sales&state=DCEeFWf45A53sdfKef424

 

Esta etapa é para validar sua aplicação para permissão de acesso. A chamada etapa de consentimento, é onde o cliente da Conta Azul ao efetuar a inserção de login e senha, dá o aceite de que ele permite que a sua aplicação colete os seus dados

Quando você enviar o link da sua aplicação, inserir os dados de login e senha da Conta Azul aparecerá esta página para você autorizar a integração:

mceclip0.png

 

 

E assim você conseguirá pegar o CODE na URL do navegador para identificar o cliente que inseriu o login:

mceclip1.png

 

Agora sua aplicação está autorizada a criar o Access e Refresh Token. Para assim conseguir gerar o Access Token da integração.

 

O que fazer se ao gerar o access_token ocorrer o erro de credencial ‘400 Bad Request'?

No cabeçalho da requisição, é necessário enviar a autenticação do tipo basic, que é composta pelo hash_64(clientId:clientSecret). O parâmetro token basic é as informações do clientId + clientSecret em base64. 

Para montá-lo, basta usar uma ferramenta que converta os dados em base64.$authToken -> $clientId:$clientSecret onde as variáveis $clientId e $clientSecret são as suas credenciais, respectivamente.

Para converter em base_64, você pode usar uma ferramenta online como essa: https://www.base64encode.org/

 

Ao entrar na ferramenta, basta você copiar o seu clientId e clientSecret (obtidos no portal de desenvolvedores) nesse formato: 'clientId:clientSecret' e depois basta clicar em "encode" para gerar o código hash_64.

 

Como criar uma aplicação no portal de desenvolvedores e ter acesso ao ClientID e Client_Secret?

  • PASSO 1 - Acessar o Portal Developers.

Criar uma conta do Portal de desenvolvedores, utilizando uma conta de e-mail do Gmail.  

 

  • PASSO 2 - Criar uma aplicação

Nesse momento, é importante informar nome, descrição e URI de redirecionamento. Caso a sua aplicação for gerar novas chaves de acesso, utilize um endereço onde sua aplicação possa pegar o code, caso contrário se for para utilizar uma única chave, pode se utilizar a URI a ser utilizada pode ser qualquer uma, como a https://www.google.com/.

Na sequência, informe o propósito a ser utilizado nessa aplicação.

 

  • PASSO 3 - Conclusão

Neste momento, você já tem acesso ao seu ClientID e Client_Secret, agora é seguir os passos para a geração das chaves a ser utilizada nas requisições, o Access e Refresh Token.

Como gerar o client_id e o client_secret?

O client_id e o client_secret são gerados automaticamente quando uma aplicação é criada no nosso portal de desenvolvedores.

Uma vez que você acesse o portal de desenvolvedores e crie sua conta, pode registrar uma aplicação. Para acessar as informações do client_id e o client_secret, clique no menu Minhas Aplicações, em seguida clique na aplicação criada. No lado direito da tela que será mostrada, constará as informações que você precisa.

Sobre a URL de direcionamento irá utilizar da plataforma que está tentando integrar. Como teste, pode utilizar a "https://google.com/" como exemplo e depois atualizar para URL desejada.

 

O que fazer se ao criar a aplicação ocorrer o erro ‘Error: Request failed with status code 500’?

Nesse caso tente realizar o acesso para criação da aplicação por uma janela anônima (clicar em seu teclado: ctrl + shift + n), na maioria das vezes resolve o problema. Caso o erro persista, pode entrar em contato pelo e-mail api@contaazul.com

 

A Conta Azul tem alguma indicação de desenvolvedor para criar uma integração? 

Temos parceiros que desenvolvem integrações entre outras plataformas e a Conta Azul. Segue abaixo site das empresas para que possa entrar em contato e verificar a que melhor te atende:

 

É possível integrar a Conta Azul com o Power BI?

Pelas nossas validações, o Power BI não funciona bem com o fluxo de autenticação da nossa API, então ainda não é possível acessar esses dados diretamente. Algo que você pode tentar é criar um conector customizado no Power BI e tentar realizar o fluxo de autenticação.

Esse processo de autenticação é descrito na nossa documentação. Contudo não testamos este fluxo para conseguir auxiliar neste processo.

 

É possível integrar o módulo de notas fiscais, financeiro e boletos?

Atualmente, não é possível acessar outros módulos além dos que foram mencionados na pergunta acima. Sendo assim, os módulos Financeiro e Notas Fiscais não estão disponíveis para integração. Porém, temos um Portal de Ideias que você pode utilizar para sugerir uma funcionalidade que você julga importante que seja implementada.

 

É possível preencher a conta bancária de uma venda via API?

Atualmente não disponibilizamos via API as funcionalidades do financeiro. O campo Conta Bancária que iria preencher para informar se iria receber via conta corrente ou conta caixinha, não é preenchido via API.

 

Como faço para criar uma conta bancária via API?

Atualmente não é possível criar a conta bancária via API, conseguimos apenas listar as contas bancárias já existentes no endpoint GET/v1/sales/banks.

 

É possível atualizar os dados de contrato via API? 

Atualmente não é possível atualizar os contratos via API.

 

Com quais status consigo enviar a venda para a Conta Azul? Consigo enviar uma venda para a Conta Azul com o status committed?

Atualmente existem dois status para enviar a venda para a Conta Azul, sendo elas pending e committed

Para utilizar o status committed, é necessário preencher o id do produto ao enviar a venda para a Conta Azul, se esse campo de id do produto estiver em branco ocorrerá erro ao enviar a venda.

 

É possível atualizar o status da venda via API? 

Atualmente não é possível atualizar via API o status da venda, a alteração de status precisa ser feita por dentro da plataforma, pois, quando este status é alterado, algumas rotinas adicionais são disparadas.

Se olharmos a documentação, https://developers.contaazul.com/#!/Sale/update_1, o atributo status não aparece pois não é permitido. 

O que você pode fazer é já criar a venda direto com o status COMMITTED caso precise que elas já estejam com este status.

 

Como faço para me tornar um parceiro e minha aplicação aparecer no menu de Integrações? 

Não estamos desenvolvendo parcerias de integrações com novas plataformas atualmente.

 

Como cadastrar um fornecedor via API? 

A parte de criação, exclusão, atualização e busca dos fornecedores está na parte 7 da nossa documentação:

mceclip2.png

 

Como faço para buscar os produtos e serviços de uma venda pela listagem de vendas? 

Atualmente não é possível buscar os produtos/serviços pela listagem das vendas, para buscar os produtos/serviços de uma venda é necessário utilizar o endpoint GET/v1/sales/{id}/items.

 

Como faço para automatizar funções do contrato como envio de fatura, boletos, lembretes de vencimento e nota fiscal via API?

Atualmente não conseguimos via API automatizar essas funções no contrato.


Compartilhe esse artigo:

Esse artigo foi útil?

Usuários que acharam isso útil: 0 de 2
Ainda não possui Conta Azul  em sua empresa?  A plataforma online fácil de usar que ajuda você a organizar e controlar seus  negócios. Experimente agora