API Vendizap

API Vendizap para integração com ERP

A Vendizap disponibiliza uma API Pública que permite que qualquer sistema ERP integre dados de produtos e pedidos permitindo que você tenha uma gestão unificada entre a loja física e a loja online com muito mais agilidade. O que é uma API? Uma API (Interface de Programação de Aplicações) é uma "ponte" que permite que dois sistemas conversem automaticamente entre si, sem ninguém precisar digitar nada. No caso da Vendizap, a API permite que o seu sistema de gestão (ERP) ou um programa feito sob medida se conecte à sua loja para, por exemplo, cadastrar produtos automaticamente ou puxar os pedidos para dentro do seu sistema, tudo sem abrir o painel e fazer manualmente. Você não precisa entender de API para usar a Vendizap. Este recurso é voltado para quem já tem ou pretende usar um sistema ERP integrado ou então contrata um desenvolvedor/ERP para fazer essa ponte. A documentação técnica completa (com todos os campos de cada endpoint) está disponível em https://api-docs.vendizap.com/ Disponibilidade A integração do seu ERP com a Vendizap (API) está disponível para os planos Profissional e Empresarial. Plano Essencial não tem acesso à integração com ERP através da API Vendizap. ERPs que já estão integrados Atualmente esses são os ERPs que estão integrados à Vendizap: Vestuar, WebPic, Nuts Tecnologia e hub/DIGITAL Se você utiliza um desses sistemas precisa fazer contato direto com ele para que a integração seja configurada. ERPs que não estão integrados Caso seu ERP não esteja listado acima, ainda é possível integrar utilizando a API pública da Vendizap Para isso faça contato com a equipe técnica ou suporte do seu ERP e encaminhe a documentação da nossa API para que eles possam analisar a possibilidade de integração https://api-docs.vendizap.com/ Nesse cenário de integração o ERP fica responsável por desenvolver e dar a manutenção necessária enquanto do lado de cá a Vendizap irá receber e disponibilizar as informações da sua conta Vendizap. Como usar a API Vendizap Antes de ativar: a API só funciona se o seu ERP fizer a conexão com a Vendizap. Confirme com o seu ERP que ele já tem essa integração (veja a lista acima) ou que a equipe técnica dele vai desenvolvê-la. As credenciais geradas nos passos abaixo servem para o ERP se conectar à sua loja. 1. Acesse Configurar > Integrações, no bloco Sistema ERP. 2. Ative a opção API Pública e clique na engrenagem. 3. Informe o Nome do sistema ERP (mínimo 3 letras). 4. Se o seu ERP quiser receber avisos de pedido da Vendizap, preencha a URL de notificação (Webhook). É opcional. 5. Mantenha ligada a chave Enviar pedidos para o WebHook se quiser que os novos pedidos sejam avisados ao ERP. 6. Clique em Visualizar dados de integração, copie o Client ID e o Client Secret e envie ao seu ERP. Atenção: o Client Secret só aparece nesse momento e não pode ser recuperado depois. Guarde em local seguro. Perdeu o Secret? Clique em Gerar novos dados de autenticação. O Client ID continua o mesmo, mas o Secret antigo deixa de funcionar na hora. Atualize o novo Secret em todos os sistemas que usam a integração. O que dá para fazer com a API? | Recurso | O que dá para fazer | Observação | | --------------------------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | Usuário | Consultar os dados da conta | Bom primeiro teste para validar as credenciais | | Produtos | Listar, buscar, cadastrar e atualizar | Não existe exclusão. Para tirar da loja, inative com "exibir": false | | Categorias | Listar, buscar, cadastrar e atualizar | | | Variações e variáveis | Criar e gerenciar as opções (tamanho, cor etc.) | | | Variações, variáveis e combinações do produto | Vincular e alterar nos produtos | | | Estoque | Consultar e atualizar o saldo | O controle de estoque precisa estar ligado no produto | | Pedidos | Listar, buscar e receber aviso de pedido novo | O aviso é feito por webhook quando um pedido é criado, cancelado ou recuperado e quando o pagamento é confirmado ou cancelado | | Descontos progressivos | Listar, buscar, cadastrar, atualizar e excluir | | | Pagamentos | Não é possível processar | | Para conhecer todas as funcionalidades, com exemplos e todos os detalhes de cada rota, a equipe técnica do ERP, ou você, se for desenvolvedor, deve consultar a documentação oficial em https://api-docs.vendizap.com/ Limite de requisições Plano Profissional: 150 requisições por hora Plano Empresarial: Sem limite prático Para garantir a melhor performance e estabilidade da nossa plataforma, estabelecemos um limite máximo de 150 requisições por hora. O que isso significa na prática? Imagine que seu sistema realiza 100 requisições às 14h30. Às 15h15, ele realiza mais 50 requisições, totalizando 150 no período. A partir desse momento, a API será temporariamente indisponível para seu sistema até às 15:31, onde serão liberadas 100 requisições. Ao exceder, a API responde com status 429 ("Limite da API atingido"). Exemplo prático: sua loja tem 300 produtos e o seu ERP precisa importá-los. - ❌ Sem boas práticas: o ERP busca um produto de cada vez → 300 requisições. No plano Profissional, ele trava na 150ª (erro 429) e só continua na hora seguinte. - ✅ Com boas práticas: o ERP usa a listagem com limit=100 → traz 100 produtos por chamada e baixa os 300 em apenas 3 requisições. ⚠️ Mesmo no Empresarial, integrações mal otimizadas (loops, falhas de script, falta de boas práticas) podem gerar consumo excessivo e sofrer bloqueio temporário. Sempre use webhooks e paginação em vez de consultas repetidas. Por que esse limite? Essa medida é fundamental para manter a estabilidade, evitando sobrecarga no sistema e garantindo que todos os nossos clientes tenham acesso à API de forma eficiente. Perguntas frequentes Como ativo a API para o meu ERP? Primeiro confirme com o seu ERP que ele faz a integração com a Vendizap. Depois, acesse Configurar > Integrações, no bloco Sistema ERP, ative a API Pública, preencha os dados e envie o Client ID e o Client Secret ao ERP. O passo a passo completo está na seção "Como usar a API Vendizap". O meu ERP já está integrado com a Vendizap? Veja a lista em "ERPs que já estão integrados". Se o seu não estiver nela, o ERP pode se integrar usando a nossa API pública. Basta a equipe técnica dele consultar a documentação. Como desativo a API? Em Configurar > Integrações, no bloco Sistema ERP, desligue a chave API Pública. O ERP deixa de ter acesso. Perdi o Client Secret. E agora? Acesse o mesmo caminho que usou para configurar e clique em Gerar novos dados de autenticação. O Client ID continua o mesmo, mas o Secret antigo deixa de funcionar na hora. Atualize o novo Secret no ERP. Quantas requisições posso fazer? No plano Profissional, 150 por hora. No plano Empresarial, não há limite por hora. Recebi o erro 429 (limite atingido). Quanto tempo preciso esperar? Não há horário fixo para reiniciar. O limite funciona em uma janela de 60 minutos: você recupera capacidade aos poucos, à medida que cada requisição completa 60 minutos. Por exemplo, se você fez 150 chamadas em 5 minutos, precisará esperar cerca de 55 minutos para a maior parte delas sair da janela. Como cadastro um produto já inativo (oculto na loja)? Envie "exibir": false no cadastro (POST /produtos). O produto é criado, mas não aparece na loja até você atualizá-lo para "exibir": true. Como inativo ou removo um produto pela API? A API não exclui produtos. Para tirar um produto da loja, atualize-o com "exibir": false (PUT ou PATCH). Ele continua salvo na sua conta e pode ser reativado a qualquer momento com "exibir": true. Como pesquiso um produto pelo código, pela descrição ou pelos detalhes? Use filtros na listagem de produtos: - Código (valor exato): GET https://app.vendizap.com/api/produtos?codigo=CAM-001 - Descrição (busca parcial): GET https://app.vendizap.com/api/produtos?descricao=camiseta - Detalhes (busca parcial): GET https://app.vendizap.com/api/produtos?detalhes=algodão Quais informações vêm em um pedido pela API? Dados do cliente (com endereço), itens com variações, combinações, quantidades e valores, forma de pagamento, valor total, frete ou taxa de entrega, vendedor (quando houver), observações e o status do pedido. Quem controla o estoque, a Vendizap ou o ERP? A Vendizap guarda o estoque da loja e permite atualizá-lo pela API. Qual sistema é a fonte da verdade, e quando atualizar, é definido pelo ERP integrado. Quando vendo na loja, a baixa de estoque vai para o ERP? Não automaticamente. Quando há um novo pedido, a Vendizap avisa o ERP por webhook (operação criado). A partir desse aviso, o ERP decide quando importar o pedido e dar baixa no estoque do lado dele. Uso o Bling. Preciso da API? Não. O Bling tem integração própria. Veja o artigo "Integração Vendizap com Bling".