Configurações e notificações
Visão geral das rotas de configuração da loja e de notificações de um usuário na API compatível com a Venddor 1.0.
Esta seção tem duas coisas pequenas, mas úteis para quem integra. As configurações são os ajustes da loja (moeda, fuso, regras de checkout, filtros da vitrine), que dá para ler e alterar uma a uma. As notificações são os avisos da caixa de entrada de um usuário, que um aplicativo pode listar.
Como funciona
- Liste as configurações de uma seção
GET /settings?section_id=checkoutdevolve só as configurações daquela seção. - Altere uma configuração
PUT /settings/{id}com{"value": ...}troca o valor de uma chave e deixa as demais da seção como estão. - Leia a caixa de notificações
GET /notifications?user_id=...devolve os avisos de um usuário, em páginas.
Conceitos
Seções de configuração
| Seção | O que guarda |
|---|---|
general | Nome da loja, e-mails de contato, idioma, moeda, fuso |
features | Quais recursos da plataforma estão ligados |
checkout | Regras do carrinho e do fechamento do pedido |
payment | Parcelamento e meios de pagamento habilitados |
shipping | Frete padrão, frete grátis, rastreio |
notification | Remetente e envio dos e-mails da loja |
storefront_filters | Filtros exibidos na vitrine |
security | Login social e verificações |
appearance | Aparência da vitrine e do painel |
vendors | Regras para sellers (lojistas) |
Rotas
| Método | Caminho | Para que serve | Página |
|---|---|---|---|
| GET | /api/v1.0/settings | Listar configurações | Configurações |
| GET | /api/v1.0/settings/{id} | Consultar uma configuração | Configurações |
| PUT | /api/v1.0/settings/{id} | Alterar uma configuração | Configurações |
| GET | /api/v1.0/notifications | Listar notificações de um usuário | Notificações |
Erros comuns
- Esquecer o
user_idem notificações. Sem ele a resposta é 400. - Usar só a chave no id da configuração. O id é
seção.chave;flow_typesozinho responde 400. - Tratar a resposta de configurações como pública. Ela inclui ajustes de e-mail e de login. Guarde-a como dado sensível.
- Contar com a ordem da lista. A ordem das configurações pode mudar entre chamadas; use
section_ide o id para localizar uma.