Primeiros passos
O caminho de zero até a primeira chamada à API legada da Venddor: endereço da loja, chave de API, convenções, erros e limites.
Esta seção reúne o que vale para todas as operações do guia rápido da API legada: onde fica a loja na internet, como provar quem você é, como são os formatos de resposta e de erro e quais limites existem. Leia uma vez; depois você só volta aqui para consultar.
O que você vai encontrar aqui
| Página | Para que serve |
|---|---|
| Endereço e ambientes | Como montar a URL base, como a plataforma descobre qual é a loja e quais famílias de rotas existem. |
| Autenticação | Chave de API com HTTP Basic, token pela rota auth_tokens e token de app. |
| Sua primeira requisição | Tutorial ponta a ponta: autenticar, listar produtos, criar cliente e criar pedido. |
| Convenções | JSON, paginação, filtros, ordenação, datas, dinheiro e ids. |
| Erros | O formato de erro e o significado de cada código HTTP. |
| Limites e boas práticas | Repetição segura, tempo limite e como consultar menos. |
| Glossário | Loja, tenant, seller, sub-pedido, status em letra e demais termos. |
| Perguntas frequentes | As dúvidas que mais aparecem na primeira integração. |
O caminho mais curto
- Descubra o endereço da loja
Peça ao responsável pela loja o endereço dela (por exemplo
https://minhaloja.io.venddor.com.br). É a sua$BASE_URL. Detalhes em Endereço e ambientes. - Gere a chave de API
No painel, abra o usuário administrador que será a conta de integração e gere a chave. Veja Autenticação.
- Faça a primeira chamada
Siga Sua primeira requisição e depois vá para a área de que precisa.