Referência da API · v1 em prévia
Três recursos. Somente leitura.
A v1 expõe coleções de produtos, vendas e concessões de acesso vinculadas ao produtor da credencial.
Recursos
Coleções em ordem decrescente pelo campo de ordenação, com desempate por id.
| Recurso | Método e rota | Escopo | Ordenação |
|---|---|---|---|
| Produtos | GET /api/v1/products | products:read | created_at |
| Vendas | GET /api/v1/sales | sales:read | created_at |
| Acessos | GET /api/v1/access | access:read | granted_at |
Envelope de sucesso
A resposta usa Cache-Control: no-store. Percorra a coleção com limit e cursor. Apenas os campos documentados fazem parte da resposta.
JSON
{ "data": [], "next_cursor": null, "version": "v1" }Convenções de consumo
Requisição
- Use HTTPS no ambiente autorizado e envie Authorization em cada chamada.
- Não use endpoints internos do painel como extensão deste contrato.
Resposta
- Trate identificadores como strings, valores monetários em centavos e datas como timestamps com fuso.
- Preserve null; ele não equivale a zero, string vazia ou data atual.
- Tolere campos adicionais e trate estados desconhecidos sem quebrar a aplicação.
Consulte cada recurso
API de produtos
GET /api/v1/products · products:read.
API de vendas
GET /api/v1/sales · sales:read.
API de acessos
GET /api/v1/access · access:read.
Referência conferida em 23 de setembro de 2026. Relatar uma dúvida na documentação.