Registros da loja (1.0)
Visão geral das rotas da API compatível com a Venddor 1.0 para páginas institucionais, pedidos de ligação, avaliações de produto e carrinhos salvos.
Esta seção reúne quatro recursos pequenos da API compatível com a Venddor 1.0 (/api/v1.0/..., ou sem o prefixo: /api/...) que sistemas externos (um ERP, um CRM, um CMS) usam para ler e manter registros da loja: as páginas institucionais, os pedidos de ligação (cliente pede que a loja ligue de volta), as avaliações de produto (a "discussão" da 1.0) e os carrinhos salvos dos clientes.
São as rotas que quem já escreveu a integração para a plataforma antiga continua usando.
Como funciona
- Autentique
Use a chave de API do administrador (Basic) ou um token de acesso (Bearer). Veja Autenticação.
- Escolha o recurso
Páginas para conteúdo institucional, pedidos de ligação para o retorno de leads, avaliações para moderar ou importar opiniões, carrinhos para ver ou limpar o carrinho salvo de um cliente.
- Trate os erros do formato 1.0
Todo erro vem como
{"message","status"}. Um 500 pode ser, na verdade, um erro de uso (id mal formado, regra de negócio); leia a mensagem.
Conceitos-chave
Letras de status da 1.0
A 1.0 usa uma letra no lugar do nome. Cada recurso tem a sua tabela, descrita na página do recurso. Para páginas: A ativa, D desativada, H escondida. Para avaliações: A aprovada, N pendente, D recusada.
Datas
As datas saem como Unix timestamp em segundos ("timestamp": 1788965088).
Endpoints
| Método | Caminho | Para quê | Acesso | Página |
|---|---|---|---|---|
| GET | /api/v1.0/pages, /api/pages | Listar páginas | autenticado | Páginas |
| GET | /api/v1.0/pages/{id}, /api/pages/{id} | Ler uma página | autenticado | Páginas |
| POST | /api/v1.0/pages, /api/pages | Criar uma página | administrador | Páginas |
| PUT | /api/v1.0/pages/{id}, /api/pages/{id} | Alterar uma página | administrador | Páginas |
| DELETE | /api/v1.0/pages/{id}, /api/pages/{id} | Apagar uma página | administrador | Páginas |
| GET | /api/v1.0/call_requests, /api/call_requests | Listar pedidos de ligação | administrador | Pedidos de ligação |
| GET | /api/v1.0/call_requests/{id}, /api/call_requests/{id} | Ler um pedido de ligação | administrador | Pedidos de ligação |
| POST | /api/v1.0/call_requests, /api/call_requests | Registrar um pedido de ligação | administrador | Pedidos de ligação |
| DELETE | /api/v1.0/call_requests/{id}, /api/call_requests/{id} | Apagar um pedido de ligação | administrador | Pedidos de ligação |
| GET | /api/v1.0/discussions, /api/discussions | Listar avaliações | administrador | Avaliações |
| GET | /api/v1.0/discussions/{id}, /api/discussions/{id} | Ler uma avaliação | administrador | Avaliações |
| POST | /api/v1.0/discussions, /api/discussions | Criar uma avaliação | administrador | Avaliações |
| DELETE | /api/v1.0/discussions/{id}, /api/discussions/{id} | Apagar uma avaliação | administrador | Avaliações |
| GET | /api/v1.0/carts/{user_id}, /api/carts/{user_id} | Ler o carrinho salvo de um cliente | administrador | Carrinhos |
| DELETE | /api/v1.0/carts/{user_id}, /api/carts/{user_id} | Esvaziar o carrinho de um cliente | administrador | Carrinhos |
Erros comuns
- Mandar um id que não é UUID.
GET /api/v1.0/pages/abcresponde500com a mensagem do banco, não 404. O mesmo vale para pedidos de ligação, avaliações e carrinhos. Na forma/api/...o caminho também só aceita UUID, mesmo que as listas devolvam ids decimais (veja Páginas). - Esperar que a leitura de páginas seja pública. É preciso estar autenticado.
- Pedir
items_per_pageacima de 250. O valor é ignorado e a lista usa 10 por página. - Esperar que a avaliação criada apareça na loja. Ela passa pelas regras de moderação e de compra da loja; veja Avaliações.
- Apagar duas vezes. A segunda remoção de uma página ou avaliação responde 500, não 404.