Integração entre ERP e ViaShop
A integração entre o ERP e a ViaShop é realizada por meio de API REST e webhooks, permitindo a sincronização automática de dados essenciais para a operação da loja virtual.
Abaixo estão descritos os fluxos de comunicação e as responsabilidades de cada lado da integração.
ERP enviando dados para a ViaShop (via API)
O ERP será responsável por enviar e manter atualizadas as seguintes informações na ViaShop:
Produtos
- Envio do cadastro inicial de produtos (primeira carga).
- Atualização de dados cadastrais (descrições, categorias, variações, etc.).
- Atualização de preços (tabelas, preços promocionais, quando aplicável).
Estoque
- Envio das quantidades disponíveis em estoque (pode ser enviado na primeira carga de produtos).
- Atualizações sempre que houver movimentações (entrada, saída, ajustes).
Clientes
- Envio do cadastro de clientes
- Atualização de dados cadastrais (razão social, CNPJ/CPF, endereço, contatos, etc.).
Pedidos
- Atualização do status dos pedidos originados na ViaShop (ex.: faturado, em separação, enviado, cancelado).
ViaShop enviando dados para o ERP (via Webhooks)
A ViaShop notifica o ERP automaticamente sempre que ocorrerem eventos relevantes na plataforma, por meio de webhooks.
Webhook é uma forma de automatizar a comunicação entre dois sistemas, permitindo que um aplicativo envie informações em tempo real para outro sempre que um evento específico ocorre.
Sua utilização evita o polling, prática de realizar sucessivas requisições GET para verificar status de pedidos e/ou pagamentos. Por ser considerado uma má prática devido ao alto consumo de recursos, recomendamos fortemente a utilização dos nossos webhooks.
A não utilização de webhooks e a implementação de consultas periódicas (polling) gera consumo desnecessário de processamento, banda e infraestrutura, aumentando significativamente os custos operacionais da plataforma. Em cenários com alto volume de requisições, esse impacto pode se tornar relevante.
Caso o integrador opte por não utilizar webhooks e implemente consultas recorrentes à API (polling), deverá observar rigorosamente os limites de requisição definidos. Caso seja necessário ultrapassar os limites padrão para viabilizar o funcionamento da integração, poderá haver geração de custos adicionais de infraestrutura para a loja vinculada à integração.
Por esse motivo, a utilização de webhooks é considerada requisito técnico recomendado para integrações em ambiente de produção.
Acesse nossa documentação de webhook
Responsabilidades do ERP
Para que a integração funcione corretamente, é importante que o ERP:
- Implemente os endpoints de recebimento de webhooks. [Saiba mais]
- Garanta o tratamento de erros, reprocessamentos e validações de dados. [Saiba mais]
- Tenha ciência do limite de requisições diários no desenvolvimento dos processos da integração. [Saiba mais]
- Tratar as paginações quando necessário. [Saiba mais]
- Não realizar consultas robotizadas em intervalos curtos (ex.: menor que a cada 3 minutos) com o objetivo de verificar alterações de dados.
- Atualização de estoque somente dos SKUs que sofreram algum tipo de alteração.