Liberação de acesso de usuário
/common/data-access-restriction/allow
Liberação de acesso de usuário
Descrição
Este endpoint é responsável por conceder acesso à visualização de um módulo específico para um usuário.
Para que o acesso seja liberado, é obrigatório informar o ID e o tipo da entidade que o usuário deseja visualizar, como por exemplo:
- Cliente
- Grupo de pedido
- Pedido
Essa exigência garante que as permissões sejam atribuídas corretamente dentro da API 🔐, mantendo o controle de acesso organizado e seguro.
Além disso, cada solicitação gera um registro em histórico, permitindo rastrear o acesso concedido e assegurando que qualquer ação realizada após a liberação da permissão esteja vinculada ao usuário responsável.
Parâmetros
Headers Obrigatórios
| Header | Valor | Descrição |
|---|---|---|
Content-Type | application/json | Tipo de conteúdo |
Authorization | Bearer {token} | Token de autenticação |
Parâmetros do Corpo
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
entity | string | ✅ | Tipo da entidade que deve liberado o acesso (cliente, grupo de pedido e pedido) |
entityId | integer | ✅ | Identificador da entidade que deve ser liberado o acesso |
Exemplo de Requisição
1curl --request POST \2 --url https://sua-loja-uappi.com.br/api/v3/common/data-access-restriction/allow\3 --header "Authorization: Bearer userToken" \4 --data '{5 "entity": "customer",6 "entityId": 17 }✅ Resposta de Sucesso
1{2 "status": true,3 "data": true4}⚠️ Possíveis erros:
Atenção: a seguir estão destacados os principais erros que podem ocorrer neste endpoint.
Os cenários descritos representam os erros mais relevantes do contexto atual, servindo como referência para entendimento e tratamento das falhas.
| Código Interno | Código Http | Descrição |
|---|---|---|
| UAPPI_STORE_USER_NOT_ALLOWED | 401 | O usuário atual não tem permissão para essa operação. |
| UAPPI_STORE_INVALID_ENTITY | 400 | A entidade informada não está disponível. |