Skip to main content
Ao configurar seu app no Painel de Parceiros, você define quais permissões ele vai solicitar ao lojista durante a instalação. O lojista visualiza essas permissões na tela de consentimento OAuth e precisa aceitá-las para concluir a instalação.

Níveis de acesso

Cada escopo da API pode ser liberado em dois níveis:
NívelMétodos HTTP permitidosQuando usar
VisualizarGETO app só precisa ler dados da loja, consultar pedidos, listar produtos, verificar estoque.
GerenciarGET, POST, PUT, PATCH, DELETEO app precisa criar ou modificar dados, atualizar status, criar cupons, registrar rastreamento.
Solicite apenas as permissões que o app realmente utiliza. Apps com permissões desnecessárias ou sem justificativa podem ser reprovados na homologação de acordo com a diretriz de aplicativos na Yampi de Menor privilégio.

Como selecionar as permissões no painel

1

Acesse as configurações do app

No Painel de Parceiros, vá em Parceiro Tech, Meus aplicativos e selecione o app e clique em Configurações da integração.
2

Localize a seção de permissões

Role até Permissões do aplicativo. Cada módulo disponível aparece com duas opções: Visualizar e Gerenciar.
3

Marque o nível correto por módulo

Para cada módulo que o app precisa acessar, marque o nível adequado. Se o app só precisa ler, marque apenas Visualizar. Se também precisa escrever, marque Visualizar e Gerenciar. O acesso de gerenciamento não inclui automaticamente o acesso de leitura.
4

Salve as configurações

Clique em Salvar.

Escopo das permissões

NívelAções permitidas
VisualizarConsultar banners configurados na loja
GerenciarCriar, editar, atualizar e excluir banners
NívelAções permitidas
VisualizarConsultar cupons, combos, descontos progressivos, frete grátis, upsells, order bumps e cashback
GerenciarCriar, editar, atualizar e excluir cupons, combos e demais regras de promoção; gerenciar saldo de cashback
NívelAções permitidas
VisualizarConsultar transportadoras, armazéns, embalagens, preços de frete e reservas de estoque
GerenciarCriar, editar, atualizar e excluir transportadoras, armazéns e embalagens; gerenciar preços de frete e reservas de estoque
NívelAções permitidas
VisualizarConsultar cadastro de clientes, endereços e clusters
GerenciarCriar, editar e atualizar clientes, endereços e regras de frete por cluster
NívelAções permitidas
VisualizarConsultar leads cadastrados na loja
GerenciarAtualizar, gerenciar e exportar leads
NívelAções permitidas
VisualizarConsultar dados da loja, credenciais, configurações de checkout e integrações ativas
GerenciarEditar, atualizar e gerenciar dados da loja, configurações de checkout e integrações
NívelAções permitidas
VisualizarConsultar pedidos, endereços, comentários, notas fiscais, etiquetas e rastreamento
GerenciarAtualizar status de pedidos, adicionar e atualizar comentários, emitir notas fiscais, gerar etiquetas e registrar rastreamento
NívelAções permitidas
VisualizarConsultar formas de pagamento, gateways, parcelamento, status de pedidos e transações
GerenciarConfigurar, atualizar e gerenciar formas de pagamento e transações
NívelAções permitidas
VisualizarConsultar páginas estáticas e redirecionamentos
GerenciarCriar, editar, atualizar e excluir páginas estáticas e redirecionamentos
Planeje as permissões com antecedência. Cada alteração gera um novo ciclo de análise e impacta lojistas com o app já instalado. Mais detalhes em Atualizando aplicativos publicados.