Permissões
Cada rota exige uma permissão. O que vale para uma integração é o que ela pediu E o que a OTL liberou para o parceiro.
Como as permissões se combinam
permissões efetivas = teto do parceiro (definido pela OTL) ∩ permissões da integração (escolhidas pelo parceiro)- A OTL define o teto: o máximo que qualquer integração daquele parceiro pode ter.
- O parceiro escolhe, dentro do teto, o que cada integração pode fazer.
- Se a OTL reduzir o teto depois, o que exceder deixa de valer na hora — em todas as integrações dele.
Para saber o que o seu token pode fazer agora, chame o /v1/eu: o campopermissoes traz as efetivas.
Lista de permissões
| Permissão | O que libera | Exige também | Situação |
|---|---|---|---|
| conta:ler | Ficha do parceiro: nome, loja e endereço de remetente. | — | Disponível |
| produtos:ler | Catálogo, preço de atacado, estoque por numeração e categorias. | — | Disponível |
| clientes:ler | Agenda de clientes finais do parceiro. | — | Disponível |
| clientes:escrever | Criar, editar e remover clientes. | clientes:ler | Disponível |
| pedidos:ler | Pedidos, itens, resultado, rastreios e comprovantes. | — | Disponível |
| pedidos:escrever | Valor de venda, despesas, rastreios e comprovantes. | pedidos:ler | Disponível |
| pedidos:criar | Fechar pedido. Gera compromisso de pagamento com a OTL. | pedidos:ler | Disponível |
| financeiro:ler | Saldo, extrato e resumo de resultado do parceiro. | — | Disponível |
| etiquetas:ler | Etiquetas de um pedido, cotação e status da SuperFrete. | — | Em breve |
| etiquetas:emitir | Criar e pagar etiqueta, cancelar. Debita a carteira SuperFrete do parceiro. | etiquetas:ler | Em breve |
| loja-hub:ler | Configuração da loja, seleção e estatísticas. | — | Em breve |
| loja-hub:escrever | Editar configuração e seleção, publicar, banners e logo. | loja-hub:ler | Em breve |
Permissões que geram cobrança
As permissões destacadas em laranja permitem que o sistema integrado gere compromisso de pagamento em nome do parceiro, sem ninguém clicar em nada. Elas ficam separadas das demais de propósito: uma integração que só lê o catálogo não deve conseguir fechar pedido por um erro de programação.
Quando falta permissão
A API responde 403 ESCOPO_INSUFICIENTE e diz qual permissão falta no campo escopoNecessario. O parceiro inclui a permissão editando a integração no painel — não é preciso gerar outro token.