Controle de Acesso
Manual de Integração — Controle de Acesso e Permissões (API do Concentrador)
1. Estrutura de Dados e Funcionamento
1.1. Leitura de Permissões (GET)
As permissões são retornadas nos objetos de Usuario e GrupoUsuario através da propriedade
permissoes.
Estrutura do Objeto de Permissão:
{
"slug": "venda.cancelar",
"descricao": "Cancelar Venda",
"sistema": "PDV"
}
Consultando Permissões Disponíveis: Endpoint: GET /api/v1/permissoes/{sistema?}
- Com parâmetro de sistema (ex.:
/api/v1/permissoes/PDV): retorna uma lista (Array) contendo apenas as permissões daquele contexto. - Sem parâmetro (ex.:
/api/v1/permissoes): retorna um Mapa (Objeto) onde a chave é o nome do sistema e o valor é a lista de permissões.
Exemplo de Resposta (sem filtro):
{
"data": {
"CONCENTRADOR": [
{ "slug": "home.visualizar_pontos_de_vendas", "descricao": "...", "sistema": "CONCENTRADOR" }
],
"PDV": [
{ "slug": "gaveta.abrir", "descricao": "...", "sistema": "PDV" }
]
}
}
1.2. Envio/Atribuição de Permissões (POST/PUT)
Para cadastrar ou editar usuários e grupos, o campo permissoes é um Array de objetos de
permissão. Cada item é identificado por slug e sistema (os dois campos compõem a identidade
da permissão); o descricao é opcional e ignorado na escrita.
Payload Esperado:
{
"nome": "Operador Exemplo",
"permissoes": [
{ "slug": "venda.excluir_item", "sistema": "PDV" },
{ "slug": "gaveta.abrir", "sistema": "PDV" },
{ "slug": "venda.listar_visualizar", "sistema": "CONCENTRADOR" }
]
}
Nota: envie apenas as permissões que deseja habilitar. Ao efetivar, as permissões atuais são todas substituídas pelo último envio.
2. Catálogo de Permissões Disponíveis
Relação de slugs (slug) e suas respectivas descrições, segmentada por sistema.
PDV
gaveta.abrir— Abrir Gaveta Manualmentecaixa.realizar_suprimento— Realizar Suprimento (Entrada)caixa.realizar_sangria— Realizar Sangria (Saída)caixa.encerrar— Realizar Encerramento de Caixacaixa.listar— Listar Encerramentos efetuados no PDVvenda.desconto_item— Aplicar Desconto no Itemvenda.desconto_venda— Aplicar Desconto no Total da Vendavenda.cancelar— Cancelar Vendavenda.excluir_item— Excluir Item da Vendavenda.listar— Listar Vendas do Caixa Atualvenda.autorizar_convenio_limite_excedido— Autorizar Venda no Convênio com Limite Excedidovenda.autorizar_convenio_limite_offline— Autorizar Venda no Convênio com Limite Offlinevenda.autorizar_convenio_saldo_vencido— Autorizar Venda no Convênio com Saldo Vencidovenda.autorizar_convenio_cliente_bloqueado— Autorizar Venda no Convênio para Cliente Bloqueadovenda.autorizar_cliente_bloqueado— Autorizar adição de Cliente Bloqueado na Vendasistema.acesso_operador— Acessar o Sistema como Operador(a)sistema.acesso_sitef_gerencial— Acessar Funcionalidade do Sitef Gerencial
CONCENTRADOR
sistema.acesso— Acessar o Sistema do Concentradorhome.visualizar_pontos_de_vendas— Visualizar a Listagem de Pontos de Venda na Homefilial.listar_visualizar— Listar Filial e Visualizar o Cadastrofilial.criar_editar— Criar e Editar Cadastro de Filialpessoa.listar_visualizar— Listar Pessoas e Visualizar o Cadastropessoa.criar_editar— Criar e Editar Cadastro de Pessoaspessoa.excluir— Excluir Cadastro de Pessoasproduto.listar_visualizar— Listar Produtos e Visualizar o Cadastroproduto.criar_editar— Criar e Editar Cadastro de Produtosproduto.excluir— Excluir Cadastro de Produtosponto_de_venda.listar_visualizar— Listar Pontos de Vendas e Visualizar o Cadastroponto_de_venda.criar_editar— Criar e Editar Cadastro de Pontos de Vendasusuario.listar_visualizar— Listar Usuários e Visualizar o Cadastrousuario.criar_editar— Criar e Editar Cadastro de Usuáriosgrupo_usuario.listar_visualizar— Listar Grupos de Usuários e Visualizar o Cadastrogrupo_usuario.criar_editar— Criar e Editar Cadastro de Grupos de Usuáriosfinalizadora.listar_visualizar— Listar Finalizadoras e Visualizar o Cadastrofinalizadora.criar_editar— Criar e Editar Cadastro de Finalizadoraspromocao.listar_visualizar— Listar Promoções e Visualizar o Cadastropromocao.criar_editar— Criar e Editar Cadastro de Promoçõesdesconto_pdv.listar_visualizar— Listar Descontos PDV e Visualizar o Cadastrodesconto_pdv.criar_editar— Criar e Editar Cadastro de Descontos PDVvenda.listar_visualizar— Listar Vendas e Visualizarvenda.listar_erros— Listar os Erros de envio das Vendasvenda.baixar_xml— Baixar XML das Vendas e/ou dos erros de Enviovenda.reenviar— Reenviar Venda para a SEFAZ de forma Individual ou em Lotecaixa.listar_visualizar— Listar Caixas e Visualizarsangria_suprimento.listar_visualizar— Listar Sangrias/Suprimentos e Visualizarlog_autorizacao_pdv.listar_visualizar— Listar Logs de Autorizações do PDV e Visualizarintegracao.listar_visualizar— Listar Integrações e Visualizar o Cadastrointegracao.editar_protheus— Editar Cadastro de Integração com o Sistema Protheusintegracao.editar_pdv— Editar Cadastro de Integração com o PDVintegracao.editar_cresce_vendas— Editar Cadastro de Integração com a Cresce Vendasintegracao.editar_tillit_integrador— Editar Cadastro de Integração com o Sistema Tillit Integradorintegracao.editar_scanntech— Editar Cadastro de Integração com a Scanntech
SELF_CHECKOUT
venda.cancelar— Cancelar Vendavenda.excluir_item— Excluir Item da Vendasistema.acesso_operador— Acessar o Sistema como Operador(a)
SuperCMS