Aplicativos API V3 - Configurações e Utilização

Por Yurgan Iasino Atualizado em 05/12/2025

O que é e quais são os pré-requisitos

O módulo de Aplicativos foi desenvolvido para facilitar o processo de integrações com a API V3, tornando-o mais seguro e personalizável.

Com essa ferramenta, é possível registrar dados para conectar outras plataformas ao ERP, permitindo tanto o envio quanto o recebimento de informações do sistema. Na configuração, você pode restringir o acesso por módulo e definir permissões para visualização, edição ou exclusão de dados.

Pré-requisitos

Disponível para todos os planos.
Usuário administrador da conta.
Extensão Gestão de Aplicativos instalada na conta.

Recursos disponíveis

Aqui estão as APIs que você pode utilizar:

API de Contato e Vendedores
API de Produtos
API de Notas Fiscais
API de Expedição
API de Pedidos
API de Separação
API de Marcas
API de Estoque
API de Listas de Preço
API de Formas de Envio
API de Formas de Pagamento
API de Intermediadores
API de Categorias
API de Informações da Conta
API de Gatilhos
API de Contas a Pagar
API de Contas a Receber

Configuração

Para adicionar um aplicativo, siga os passos:

Acesse menu > configurações > aba geral > Aplicativos.
Clique no botão + novo aplicativo.
No campo Nome do aplicativo, preencha com uma descrição para identificar a integração. Sugerimos usar o nome da plataforma que será conectada.
No campo URLs de Redirecionamento, informe a URL fornecida pelo desenvolvedor da plataforma a ser integrada. Ela será usada para autenticar o aplicativo.

Chaves de acesso

Após salvar o aplicativo, as chaves Client ID e Client Secret serão geradas. Elas são essenciais para permitir que a outra plataforma acesse os dados da sua conta no ERP.

Para obtê-las, salve a configuração, edite o aplicativo recém-criado e copie as chaves na seção Chaves de acesso. Envie essas informações de forma segura para o seu desenvolvedor.

Atenção: estes dados são sensíveis. Não os divulgue sem garantir a segurança, pois eles dão acesso total aos dados da sua conta.

Se precisar renovar a chave, clique no botão gerar novas chaves. O sistema irá invalidar a chave antiga e criar uma nova automaticamente.

Permissões do aplicativo

Nesta seção, você escolhe quais módulos e funções o aplicativo poderá acessar.

Selecione os módulos marcando a caixa de seleção ao lado de cada um.
Defina as permissões de uso à direita:

Leitura: a aplicação poderá apenas visualizar e obter informações.
Incluir e editar: a aplicação poderá inserir e editar informações.
Excluir: a aplicação poderá excluir informações existentes.

3. Ao final, clique em Salvar para aplicar as permissões.

Importante: cada conta do ERP pode ter, no máximo, 5 aplicativos configurados.

Utilização

Com o aplicativo configurado, a integração via API pode ser finalizada. O aplicativo permitirá que a plataforma externa realize chamadas para ler, inserir ou excluir dados no seu sistema, conforme as permissões definidas.

APIs disponíveis

A liberação de cada API depende dos módulos que você autorizou na seção Permissões do aplicativo.

API de Contatos: Inclui, obtém, edita e exclui cadastros de contatos. Também libera a API para obter dados de vendedores.
API de Produtos: Inclui, obtém, edita e exclui produtos.
API de Notas Fiscais: Inclui, obtém, edita e exclui notas fiscais.
API de Expedição: Inclui, obtém, edita e exclui agrupamentos de expedição.
API de Pedidos: Inclui, obtém, edita e exclui pedidos de venda.
API de Separação: Inclui, obtém e edita informações de separações de estoque.
API de Marcas: Cadastra, obtém e edita marcas de produtos.
API de Estoque: Inclui, obtém e edita registros de estoque.
API de Listas de Preço: Obtém informações das listas de preços cadastradas.
API de Formas de Envio: Obtém informações das formas de envio cadastradas.
API de Formas de Pagamento: Obtém informações das formas de pagamento cadastradas.
API de Intermediadores: Obtém informações dos intermediadores cadastrados.
API de Categorias: Obtém informações das categorias de produtos cadastradas.
API de Informações da Conta: Obtém os dados da sua empresa.
API de Gatilhos: Ativa gatilhos de lançamento de contas e estoque.
API de Contas a Pagar: Inclui, obtém e edita registros de contas a pagar.
API de Contas a Receber: Inclui, obtém e edita registros de contas a receber.

Para mais detalhes técnicos, consulte nossa documentação oficial.

Limites Disponíveis

Para garantir a estabilidade e a segurança do sistema, existem limites de requisições por minuto na API V3, que variam conforme o seu plano.

Básico e Crescer: 60 requisições por minuto (30 de escrita).
Essencial e Evoluir: 120 requisições por minuto (60 de escrita).
Grande e Potencializar: 240 requisições por minuto (100 de escrita).

Ao ultrapassar o limite, a chamada retornará um erro.

Observação: o limite de requisições é por conta, não por aplicativo. Se você tiver mais de um aplicativo, eles compartilharão o mesmo limite.

Como alterar as permissões do aplicativo

Acesse menu > configurações > aba Geral > Aplicativos.
Clique em detalhes no aplicativo que deseja editar.
Na seção Permissões do aplicativo, ajuste as liberações conforme sua necessidade.
Vá até a seção Chaves de acesso e clique em gerar novas chaves.
Copie a nova chave gerada e clique em salvar.
Insira a nova chave na sua plataforma integrada para que a conexão continue funcionando.

Atenção: é fundamental renovar a chave Client Secret após alterar as permissões. Caso contrário, a integração pode apresentar falhas de conexão.

Como excluir um aplicativo

Acesse menu > configurações > aba Geral > Aplicativos.
Clique em detalhes no aplicativo que deseja remover.
Clique no botão ações e selecione a opção excluir aplicativo.
Uma vez excluído, o aplicativo não poderá ser restaurado e os vínculos criados com ele serão perdidos.

Detalhes importantes

É ideal que sejam cadastrados aplicativos diferentes para integrações diferentes.
O módulo de Aplicativos é direcionado para a nossa API V3. Se você utiliza a API V2, este módulo não é necessário.
Um aplicativo excluído não pode ser recuperado.
Os limites de chamadas por minuto são definidos por conta, não por aplicativo.