Controle de Acesso

Por Administrador 2026-07-15

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 Manualmente
  • caixa.realizar_suprimento — Realizar Suprimento (Entrada)
  • caixa.realizar_sangria — Realizar Sangria (Saída)
  • caixa.encerrar — Realizar Encerramento de Caixa
  • caixa.listar — Listar Encerramentos efetuados no PDV
  • venda.desconto_item — Aplicar Desconto no Item
  • venda.desconto_venda — Aplicar Desconto no Total da Venda
  • venda.cancelar — Cancelar Venda
  • venda.excluir_item — Excluir Item da Venda
  • venda.listar — Listar Vendas do Caixa Atual
  • venda.autorizar_convenio_limite_excedido — Autorizar Venda no Convênio com Limite Excedido
  • venda.autorizar_convenio_limite_offline — Autorizar Venda no Convênio com Limite Offline
  • venda.autorizar_convenio_saldo_vencido — Autorizar Venda no Convênio com Saldo Vencido
  • venda.autorizar_convenio_cliente_bloqueado — Autorizar Venda no Convênio para Cliente Bloqueado
  • venda.autorizar_cliente_bloqueado — Autorizar adição de Cliente Bloqueado na Venda
  • sistema.acesso_operador — Acessar o Sistema como Operador(a)
  • sistema.acesso_sitef_gerencial — Acessar Funcionalidade do Sitef Gerencial

CONCENTRADOR

  • sistema.acesso — Acessar o Sistema do Concentrador
  • home.visualizar_pontos_de_vendas — Visualizar a Listagem de Pontos de Venda na Home
  • filial.listar_visualizar — Listar Filial e Visualizar o Cadastro
  • filial.criar_editar — Criar e Editar Cadastro de Filial
  • pessoa.listar_visualizar — Listar Pessoas e Visualizar o Cadastro
  • pessoa.criar_editar — Criar e Editar Cadastro de Pessoas
  • pessoa.excluir — Excluir Cadastro de Pessoas
  • produto.listar_visualizar — Listar Produtos e Visualizar o Cadastro
  • produto.criar_editar — Criar e Editar Cadastro de Produtos
  • produto.excluir — Excluir Cadastro de Produtos
  • ponto_de_venda.listar_visualizar — Listar Pontos de Vendas e Visualizar o Cadastro
  • ponto_de_venda.criar_editar — Criar e Editar Cadastro de Pontos de Vendas
  • usuario.listar_visualizar — Listar Usuários e Visualizar o Cadastro
  • usuario.criar_editar — Criar e Editar Cadastro de Usuários
  • grupo_usuario.listar_visualizar — Listar Grupos de Usuários e Visualizar o Cadastro
  • grupo_usuario.criar_editar — Criar e Editar Cadastro de Grupos de Usuários
  • finalizadora.listar_visualizar — Listar Finalizadoras e Visualizar o Cadastro
  • finalizadora.criar_editar — Criar e Editar Cadastro de Finalizadoras
  • promocao.listar_visualizar — Listar Promoções e Visualizar o Cadastro
  • promocao.criar_editar — Criar e Editar Cadastro de Promoções
  • desconto_pdv.listar_visualizar — Listar Descontos PDV e Visualizar o Cadastro
  • desconto_pdv.criar_editar — Criar e Editar Cadastro de Descontos PDV
  • venda.listar_visualizar — Listar Vendas e Visualizar
  • venda.listar_erros — Listar os Erros de envio das Vendas
  • venda.baixar_xml — Baixar XML das Vendas e/ou dos erros de Envio
  • venda.reenviar — Reenviar Venda para a SEFAZ de forma Individual ou em Lote
  • caixa.listar_visualizar — Listar Caixas e Visualizar
  • sangria_suprimento.listar_visualizar — Listar Sangrias/Suprimentos e Visualizar
  • log_autorizacao_pdv.listar_visualizar — Listar Logs de Autorizações do PDV e Visualizar
  • integracao.listar_visualizar — Listar Integrações e Visualizar o Cadastro
  • integracao.editar_protheus — Editar Cadastro de Integração com o Sistema Protheus
  • integracao.editar_pdv — Editar Cadastro de Integração com o PDV
  • integracao.editar_cresce_vendas — Editar Cadastro de Integração com a Cresce Vendas
  • integracao.editar_tillit_integrador — Editar Cadastro de Integração com o Sistema Tillit Integrador
  • integracao.editar_scanntech — Editar Cadastro de Integração com a Scanntech

SELF_CHECKOUT

  • venda.cancelar — Cancelar Venda
  • venda.excluir_item — Excluir Item da Venda
  • sistema.acesso_operador — Acessar o Sistema como Operador(a)