API REST da WSCommerce para o seu ERP.
Quando o ERP, o BI ou um painel precisa ler ou escrever na loja virtual, a WSCommerce expõe uma API REST própria, documentada e com acesso controlado por credencial. Não depende de conector de terceiro.
Nem todo ERP tem um conector pronto, e nem toda integração precisa de um. Quando o sistema de gestão, o BI ou um painel de vendas tem equipe para consumir uma API, o caminho mais curto é o contrário do habitual: a loja expõe a API, e o ERP lê e escreve nela. A WSCommerce, plataforma própria da Webstorm, tem essa API pronta e em operação.
Para que serve
- Painel de vendas no ERP ou no BI: número de vendas, faturamento confirmado e faturado, pedidos por situação, produtos mais vendidos, origem por canal.
- Catálogo, preço e estoque mantidos pelo ERP: o ERP cadastra e atualiza produtos, marcas e características, e envia preço e estoque em lote.
- Pedidos: o ERP lê os pedidos completos, com cliente, itens, pagamentos, nota e entrega, e devolve a situação e a nota fiscal.
- Clientes: nome, e-mail e telefone, com data de cadastro e de alteração, para o ERP manter a base dele.
Como funciona
- Credencial por consumidor: cada ERP, BI ou painel recebe um identificador e um segredo próprios, criados no painel da loja. Autenticação OAuth 2.0 do tipo client credentials, com token de curta duração; quando a ferramenta só aceita um cabeçalho fixo, existe o modo de chave estática.
- Escopos por domínio: pedidos, clientes, métricas, catálogo e estoque, cada um em leitura ou escrita. A credencial só alcança o que foi liberado para ela, e a leitura é o padrão.
- Documentação hospedada na própria loja, protegida por senha, com a referência OpenAPI e uma coleção Postman geradas da mesma fonte que a API: o que está escrito é o que responde.
- Carga incremental: paginação por cursor e filtro por data de alteração, para o ERP buscar só o que mudou desde a última leitura.
- Operação visível: cada chamada fica registrada no painel da loja, com credencial, método e resultado; limite de requisições por credencial, com os cabeçalhos padrão de limite; lista de endereços IP autorizados, se a empresa quiser.
O que a API disponibiliza
| Domínio | Leitura | Escrita |
|---|---|---|
| Pedidos | Lista e detalhe, com cliente, itens, pagamentos, nota fiscal e entrega; filtros por período, situação e origem | Situação do pedido e número da nota fiscal, um a um ou em lote |
| Clientes | Nome, e-mail, telefone, tipo e datas; filtro por alteração | Reservada |
| Métricas | Resumo do período, série por dia, por produto e por origem de venda | Não se aplica |
| Produtos e catálogo | Produto por código, por identificador ou por data de alteração, com estoque e situação | Cadastro e atualização de produto, marcas e características |
| Preço e estoque | Junto do produto | Em lote, por item de venda |
Valores em reais, datas no horário de Brasília com o fuso explícito, situações de pedido em português e erros com código e mensagem. O que cada loja libera depende do que a operação precisa: a lista acima é o que a API cobre hoje, não o que toda integração precisa usar.
Quando faz sentido
- O ERP não tem conector pronto para loja virtual, mas tem equipe ou fornecedor que consome API.
- O sistema de gestão é próprio, de nicho ou antigo, e o fluxo precisa seguir a regra dele.
- A empresa quer o dado da loja dentro do BI ou do painel que já usa, sem exportação manual.
Quando o ERP já tem conector na WSCommerce, como o Bling, o conector costuma ser o caminho mais curto. A lista de ERPs integrados está em Integração de Sistemas.
Perguntas frequentes
Preciso de desenvolvimento do lado do ERP?
Sim. A loja expõe a API e a documentação; quem consome é o ERP, o BI ou o painel. A Webstorm entrega a credencial, a referência OpenAPI e a coleção Postman, e acompanha o fornecedor do ERP nos testes.
A API é segura?
Cada consumidor tem credencial própria, com escopos definidos e, se quiser, lista de endereços IP autorizados. O token expira, cada chamada fica registrada no painel da loja e há limite de requisições por credencial.
Meu ERP fala XML, no padrão antigo. Serve?
Serve. A WSCommerce também atende ERPs que trocam XML pelo padrão SOAP, e a API REST pode conviver com ele, inclusive usando as mesmas regras de negócio por baixo.
Dados pessoais dos clientes entram na API?
Só o necessário e só com o escopo de clientes: nome, e-mail e telefone. CPF, CNPJ e endereço ficam fora por padrão e só entram se a operação precisar, em escopo separado e registrado.
Quanto custa e quanto tempo leva?
Depende do escopo. Preço e prazo são definidos em proposta, depois do diagnóstico, que é gratuito, porque dependem do que a operação precisa.
Quem cuida da API depois que ela entra no ar?
A própria Webstorm, no serviço de Suporte e Sustentação: monitoramento, ajustes e evolução contínua.
Quer ligar o seu ERP à loja pela API?
Deixe nome e WhatsApp. Alguém da Webstorm fala com você em horário comercial.
Prefere começar pelo diagnóstico?
Faça o pré-diagnóstico em 2 minutos. É gratuito.