Guia rápido
A API legada da Venddor em uma página: para que serve, para quem é e as seis áreas do guia rápido.
A API legada da Venddor mantém o contrato da plataforma anterior (a Venddor 1.0) para que os sistemas que já foram escritos para ela continuem funcionando sem alteração: um ERP que importa pedidos, um PDV que cadastra clientes, um conector que lê o catálogo, um aplicativo de vendedor. Para migrar, basta trocar o endereço da loja.
Este guia rápido cobre as seis áreas que quase toda integração usa: produtos, clientes, pedidos, categorias, características e caixas (embalagens). Para cada operação você vê a descrição, os parâmetros e exemplos prontos para copiar em cURL, JavaScript e Python.
Para quem é
Para quem mantém ou constrói integrações no contrato da Venddor 1.0 . Você precisa saber HTTP e JSON, e nada mais: os conceitos da plataforma (loja, seller, sub-pedido, status em letra) são explicados nas próprias páginas e no glossário.
Se você ainda não fez nenhuma chamada, comece por Primeiros passos. Em poucos minutos você gera a chave, lista produtos, cria um cliente e cria um pedido (Sua primeira requisição).
Como a API se organiza
| Ponto | Como é |
|---|---|
| Prefixo | /api/v1.0/... (também /api/...) |
| Autenticação | HTTP Basic e-mail:chave_de_api, ou Bearer da rota auth_tokens |
| Dinheiro | string decimal: "49.90" |
| Datas | Unix timestamp em segundos |
| Ids | UUID em texto (decimal em /api/...) |
| Status | letra (O, P, A...) |
| Paginação | page e items_per_page, resposta com params |
| Erros | {"status": 404, "message": "..."} |
Os detalhes de cada ponto estão em Convenções e Erros.
As seis áreas deste guia
Tudo o que não é uma dessas seis áreas (frete, PDV, aplicativos de vendedor, API móvel, blocos da vitrine e o restante das rotas de compatibilidade) está na referência completa.