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

Por Yu I. Atualizado em 20/03/2026

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

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 a partir do plano Construa.
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: Gerencia o ciclo de vida completo (incluir, obter, editar e excluir) de clientes, fornecedores e vendedores. Permite o gerenciamento de endereços secundários e marcadores.
API de Produtos: Focada no catálogo. Permite a manutenção de produtos simples e com variações (grade), além de possibilitar a atualização de preços e descrições em massa.
API de Notas Fiscais (NF-e/NFC-e): Inclui a emissão, consulta e cancelamento. Gerencia o fluxo desde o rascunho até a autorização pela SEFAZ, permitindo também a obtenção do XML e PDF (DANFE).
API de Expedição: Controla a logística de saída. Permite criar romaneios, agrupar objetos para postagem e atualizar o status de rastreio junto aos canais de venda.
API de Pedidos de Venda: O coração da operação. Permite incluir novos pedidos vindos de e-commerces, alterar situações (ex: de "Aberto" para "Aprovado") e consultar detalhes de itens e valores.
API de Separação (Picking): Facilita a logística interna. Permite enviar pedidos para a fila de conferência, garantindo que o item bipado no estoque seja o mesmo vendido.
API de Marcas: Cadastra e organiza as marcas dos produtos, essencial para a sincronização correta com marketplaces que exigem esse campo como obrigatório.
API de Estoque: Oferece controle em tempo real. Permite consultar o saldo físico e reservado em diferentes depósitos e realizar lançamentos de ajuste (entrada/saída).
API de Listas de Preço: Obtém as tabelas de preços configuradas, permitindo que sistemas externos consultem valores diferenciados para atacado ou promoções específicas.
API de Formas de Envio: Retorna as transportadoras e métodos de envio ativos na conta, facilitando o vínculo correto da logística no momento da importação do pedido.
API de Formas de Pagamento: Lista as condições de pagamento (Pix, Cartão, Boleto) para que a conciliação financeira entre o sistema externo e o Tiny seja automática.
API de Intermediadores: Gerencia os dados de marketplaces ou gateways de pagamento, atendendo às normas fiscais de identificação do intermediador na nota fiscal.
API de Categorias: Organiza a árvore de categorias dos produtos, permitindo a criação de hierarquias (Pai > Filho) para melhor navegação no catálogo.
API de Informações da Conta: Retorna os dados cadastrais da empresa (Matriz/Filial) e fornece métricas de uso da API (limites e consumo).
API de Gatilhos (Triggers): Configura automações de sistema que disparam lançamentos financeiros ou de estoque sempre que uma ação específica ocorre no ERP.
API de Contas a Pagar: Gestão de obrigações financeiras. Permite incluir contas, editar datas de vencimento e realizar a baixa de pagamentos a fornecedores.
API de Contas a Receber: Gestão de fluxo de caixa. Permite monitorar recebimentos de vendas, editar parcelas e conciliar entradas financeiras.

Observações Importantes da V3

Protocolo: Agora opera 100% em JSON via métodos HTTP (GET, POST, PUT, DELETE).
Autenticação: Utiliza OAuth2, exigindo o client_id e client_secret gerados no módulo de extensões do Tiny.
Performance: A V3 é otimizada para ser mais rápida que a V2, mas possui limites de requisições por minuto (Rate Limit) baseados no seu plano.

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.

Este artigo foi útil para você?