Documentação API » Credenciais de acesso
Export

Credenciais de acesso

Login

Processo responsável por efetuar o login de autenticação no sistema. O backend irá retornar 200 - OK com as informações do usuário em caso de sucesso. Se as credencias estiverem incorretas, irá retornar erro 401 - Unauthorized indicando falha na autenticação. Se existe alguma restrição no cadastro do usuário, irá retornar erro 400 retornando as informações do erro apresentado.

Requisição  
Método POST
URL /api/v1/login
Estrutura dos cabeçalhos da requisição (Headers)  
Nome Descrição
Authorization Basic auth contendo os dados de autenticação do client

Exemplo de resposta

A API retornará um objeto contendo as informações do usuário.

Propriedade Tipo Tamanho Obrigatório Descrição
id Long - Sim

Identificação do usuário
nome String 50 Sim

Nome do usuário
privilegio String 15 Sim

Privilégio do usuário
REPRESENTANTE,
SUPERVISOR,
GERENTE,
ADMINISTRADOR,
TECNICO,
CLIENTE,
SISTEMA
exibirTodosClientes String 3 Sim

Exibir todos os clientes do representante logado

SIM

NAO
permissao Object - Sim

Permissões do usuário
permissao.visualizarCustoProduto String 3 Sim

Vusualiza custo do produto

SIM

NAO
permissao.filiaisAcesso String 100 Sim

Lista de filiais de acesso
permissao.filialPadrao Integer - Sim

Filial padrão
representante Integer Object Não

Representante vinculado no usuário
representante.id Integer - Sim

Id do representante
representante.tabelaPreco Integer - Não

Tabela de preço vinculada
supervisor Integer   Não

Supervisor vinculado
tecnico Integer   Não

Técnico vinculado
cliente Integer   Não

Cliente vinculado
usuarioSistema Integer   Não

Usuário interno do sistema vinculado
sistema String 20 Sim

Sistema que foi autenticado

INDUSTRIAL

COMERCIAL
tokenJWT String   Sim

Token gerado pela API que deve ser enviado no header das requisições

 
{
    "id": 70,
    "nome": "USUARIO",
    "privilegio": "SISTEMA",
    "exibirTodosClientes": "NAO",
    "permissao": {
        "visualizarCustoProduto": "NAO",
        "filiaisAcesso": "1,2",
        "filialPadrao": 1
    },
    "usuarioSistema": 258,
    "sistema": "INDUSTRIAL"
}
{
    "id": 71,
    "nome": "REPRESENTANTE",
    "privilegio": "REPRESENTANTE",
    "exibirTodosClientes": "SIM",
    "permissao": {
        "visualizarCustoProduto": "NAO",
        "filiaisAcesso": "1",
        "filialPadrao": 1
    },
    "representante": {
        "id": 199,
        "tabelaPreco": 92
    },
    "sistema": "INDUSTRIAL"
}
{
    "id": 73,
    "nome": "SUPERVISOR",
    "privilegio": "SUPERVISOR",
    "exibirTodosClientes": "NAO",
    "permissao": {
        "visualizarCustoProduto": "NAO"
    },
    "supervisor": 10,
    "sistema": "INDUSTRIAL"
}
{
    "id": 74,
    "nome": "TECNICO",
    "privilegio": "TECNICO",
    "exibirTodosClientes": "NAO",
    "permissao": {
        "visualizarCustoProduto": "NAO"
    },
    "tecnico": 10,
    "sistema": "INDUSTRIAL"
}
{
    "id": 75,
    "nome": "GERENTE",
    "privilegio": "GERENTE",
    "exibirTodosClientes": "NAO",
    "permissao": {
        "visualizarCustoProduto": "NAO"
    },
    "sistema": "INDUSTRIAL"
}
{
    "id": 76,
    "nome": "CLIENTE",
    "privilegio": "CLIENTE",
    "exibirTodosClientes": "NAO",
    "permissao": {
        "visualizarCustoProduto": "NAO"
    },
    "cliente": 10,
    "sistema": "INDUSTRIAL"
}
{
    "id": 77,
    "nome": "ADMINISTRADOR",
    "privilegio": "ADMINISTRADOR",
    "exibirTodosClientes": "NAO",
    "permissao": {
        "visualizarCustoProduto": "NAO"
    },
    "sistema": "INDUSTRIAL"
}

Editar usuário

Atualiza o cadastro de um usuário na base de dados.

Requisição  
Método PUT
URL /api/v1/login/{id}
Formato do conteúdo application/json
Exemplo de uso
/api/v1/login/70
Estrutura de dados da requisição        
Propriedade Tipo Tamanho Obrigatório Descrição
nome String 50 Sim Descrição do usuário
senha String 50 Sim Nova senha do usuário 
{
    "nome": "USUARIO TESTE BACKOFFICE",
    "senha": "123456"
}

Editar o Push Token do usuário

Atualiza o token do usuário pelo id do usuário

Requisição  
Método PUT
URL /api/v1/login/{id}/token
Formato do conteúdo application/json
Exemplo de uso
/api/v1/login/70/token
Estrutura de dados da requisição        
Propriedade Tipo Tamanho Obrigatório Descrição
pushToken String 300 Sim Token do Firebase Cloud Messaging 
{
    "pushToken": "eAZHxs82RQWKU53ZlaG0yQ:APA91bGVpa4vrIOiztBN_NjTIBxncvfAQpmIw4BzOSCD6vmFkPJrGfu7-r8IzS3FsWSjA25vzP07cNwwUVi7O4D-LT2VQMf9_uOLja34t3F3et_YgEY3e9iciI6clr3g775Up7DB5aP-"
}

Listar Módulos

Lista os módulos que o usuário tem acesso habilitado no sistema.

Requisição
Método GET
URL /api/v1/login/{usuarioId}/modulos
Formato do conteúdo application/json
Parâmetro de URL
usuarioId Id do usuário logado
Exemplo de uso
/api/v1/login/1/modulos

Exemplo de resposta

A API irá retornar uma lista de objetos contendo os módulos ativos que o usuário tem acesso habilitado.

Propriedade Tipo Tamanho Obrigatório Descrição
modulo String 30 Sim

Nome do módulo
descricao String 256 Sim

Descrição do módulo
subModulos Array - Não

Lista de submódulos
subModulos.nome String 300 Não

Nome identificador do submódulo

 
[
    {
        "modulo": "moProdutos",
        "descricao": "Produtos",
        "subModulos": []
    },
    {
        "modulo": "moInventario",
        "descricao": "Inventário",
        "subModulos": []
    },
    {
        "modulo": "moApontamento",
        "descricao": "Apontamento",
        "subModulos": []
    },
    {
        "modulo": "moProducao",
        "descricao": "Produção",
        "subModulos": [
            {
                "nome": "moProducaoGramatura"
            }
        ]
    },
    {
        "modulo": "moEntrada",
        "descricao": "Entrada",
        "subModulos": [
            {
                "nome": "moEntradaInsumo"
            }
        ]
    }
]
Back to top