A VentasxMayor tem uma API REST para você conectar o seu próprio sistema e gerenciar produtos, categorias, tabelas de preços, clientes e pedidos de fora do painel. É o caminho quando você quer cadastrar produtos a partir de outro aplicativo, sincronizar com um desenvolvimento próprio ou automatizar tarefas que hoje faz na mão.
Passo a passo
- No menu lateral, vá em Configuração → ERP.
- Escolha a opção API Token entre as integrações disponíveis.
- Gere o token no próprio cartão. Guarde-o assim que aparecer: é a credencial do seu negócio.
- No seu sistema, envie cada requisição HTTP com o cabeçalho
Authorization: Bearer <seu-token>. - Aponte suas chamadas para
/api/v1/no domínio da sua loja.
No mesmo cartão você encontra o link para a documentação técnica completa, com o detalhe de cada campo.
O que você pode fazer
A API trabalha com cinco recursos. Os produtos são endereçados pelo código; os demais, pelo id.
| Recurso | Você pode |
|---|---|
/api/v1/products | listar, criar, ler, alterar e excluir |
/api/v1/products/{codigo}/images | adicionar e excluir imagens |
/api/v1/products/{codigo}/prices | ler e gravar os preços por tabela |
/api/v1/categories | listar, criar, ler, alterar e excluir |
/api/v1/price-lists | listar, criar, ler, alterar e excluir |
/api/v1/customers | listar, criar, ler e alterar |
/api/v1/orders | listar, ler e alterar |
Dois limites de projeto que vale entender antes de começar:
- Os pedidos não são criados pela API. Eles são lidos e alterados. Um pedido nasce no carrinho da sua loja ou no painel, porque é ali que preços, tabelas e descontos são resolvidos.
- Os clientes não são excluídos pela API. Eles são criados, lidos e alterados.
Limites e códigos de erro
- 120 chamadas por minuto por token e por método. Se você passar disso, recebe
429. - 5 MB de tamanho máximo de corpo. Acima disso, a resposta é
413.
| Código | O que aconteceu |
|---|---|
400 | o corpo não é um JSON válido |
401 | falta o token ou ele não é válido |
403 | o serviço de API não está ativo na sua conta |
404 | a rota não existe, ou o negócio não existe |
405 | a rota existe, mas não com esse método |
409 | o recurso mudou enquanto você o editava: leia de novo e tente outra vez |
413 | o corpo passa de 5 MB |
422 | os dados não passaram na validação |
429 | você ultrapassou o limite de chamadas por minuto |
Se algo não aparece
- Você não vê a opção API Token em Configuração → ERP. Hoje a API é oferecida apenas a negócios da Argentina. Em outros países a opção não aparece.
- Você tem o token, mas todas as chamadas retornam
403. A API é um serviço contratado à parte. Se ele foi cancelado ou nunca foi ativado, o token existe mas não libera nada. Fale com a gente para ativá-lo. - Aparece
401com um token que antes funcionava. Confira se o cabeçalho está indo comoAuthorization: Bearer <token>, sem aspas nem espaços a mais.
Dicas
- Guarde o token como um segredo do seu aplicativo, igual a uma senha. Quem tiver o token consegue ler e gravar o catálogo e os clientes do seu negócio.
- Use sempre o código do produto como identificador estável. É o mesmo que você usa no seu estoque e nos seus pedidos de atacado, e ele não muda mesmo que você edite o produto.
- Se for cadastrar muitos produtos de uma vez, respeite o limite por minuto e espace as chamadas. Um lote organizado é mais rápido do que ficar tentando de novo depois de um
429. - Para uma carga inicial grande de catálogo, avalie antes a importação por planilha: resolve o mesmo problema sem escrever código.