Guia rápido
A API da Venddor em uma página: para que serve, para quem é e as seis áreas do guia rápido.
A API da Venddor permite que o seu sistema converse com uma loja da plataforma sem passar pelo painel: um ERP que importa pedidos, um PDV que cadastra clientes, um BI que lê o catálogo, um aplicativo de vendedor, um marketplace que sincroniza estoque. Tudo o que o painel de administração faz com produtos, clientes e pedidos também pode ser feito por HTTP e JSON.
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 desenvolvedores que integram um sistema externo a uma loja Venddor. 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ê autentica, lista produtos, cria um cliente e cria um pedido (Sua primeira requisição).
Como a API se organiza
| Ponto | Como é |
|---|---|
| Prefixo | /api/v1/admin/... para a administração da loja |
| Autenticação | Bearer JWT (login com e-mail e senha) |
| Dinheiro | inteiro em centavos: 4990 |
| Datas | RFC 3339, em UTC |
| Ids | UUID em texto |
| Status | letra mais o texto do status |
| Paginação | page e per_page, com total e total_pages na resposta |
| Erros | {"error": "..."} |
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 (pagamentos, frete, promoções, vitrine, painel do seller, webhooks e o restante da plataforma) está na referência completa, que começa pelos fundamentos.