Autenticação | Credenciais de acesso

Este artigo documento os processo de autenticação, autorização, consulta de informações de acesso e alteração de dados relacionados a uma credencial.

Login

Processo responsável por efetuar o login de autenticação no sistema.

Exemplo de resposta

{
	"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJkYXRhIjp7InVzdWFyaW8iOiJhZG1pbkBtaWNyb3N5cy5pbmYuYnIifSwiaWF0IjoxNzAyMzEzMDU3LCJleHAiOjE3MDI5MTc4NTcsImlzcyI6Imh0dHBzOi8vYXBpLm1zeXNnZXN0b3IuY29tIn0.A-xAiqN33l_sVRqAfHxR37masTvdAnEIlXkbNBZBhBg",
	"token_type": "bearer",
	"refresh_token": "0e1cd7bb-a71f-4208-b7fc-078abf313732",
	"scope": "create read update delete"
}

Logout

Efetua o logout do sistema, esse processo utiliza o token de autenticação enviado no header da requisição para identificar a credencial e invalida esse token. Mais informações de como funciona o processo de autenticação podem ser encontradas aqui.

Alteração de e-mail

Este é o processo em que o usuário solicita a alteração do seu e-mail no sistema.

Exemplo de requisição

{
	"emailAtual": "emailatual@gmail.com",
	"emailNovo": "emailnovo@gmail.com",
	"senha": "alt554djbshg"
}

Ativação de e-mail

Processo responsável por validar e ativar um novo e-mail do usuário. Este processo é realizado após a solicitação de alteração do e-mail.

Este end-point não requer autenticação.

Exemplo de requisição

{
    "token": "f59353da-d512-4dc8-b697-5f8d9c531e65"
}

Alteração de senha

Processo que possibilita a troca de senha da credencial de acesso do usuário.

Exemplo de requisição

{
	"senhaAtual": "123dasde3r8ad",
	"senhaNova": "alt554djbshg"
}

Recuperação de senha

Caso o usuário esqueça a sua senha é possível executar este processo de recuperação de senha.

Este end-point não requer autenticação.

Exemplo de requisição

{
	"email": "meuemail@gmail.com"
}

Confirmação de credencial

Após a inserção de uma credencial é necessário realizar o processo de confirmação.

Este end-point não requer autenticação.

Exemplo de requisição

{
	"token": "f59353da-d512-4dc8-b697-5f8d9c531e6",
    "senha": "asda54d565a4das"
}

Confirmação de senha

Após a solicitação de recuperação de senha de uma credencial é necessário realizar o processo de confirmação.

Este end-point não requer autenticação.

Exemplo de requisição

{
	"token": "f59353da-d512-4dc8-b697-5f8d9c531e6",
    "senha": "asda54d565a4das"
}

Informações da credencial

Para saber informações a respeito da credencial logada basta utilizar este recurso.

Exemplo de resposta

{
    "id": "dbff5be0-4f2a-11ea-b77f-2e728ce881255",
    "email": "contato@minhaempres.com.br",
    "autoridade": "USER",
    "ativa": true,
    "expirada": false,
    "bloqueada": false,
    "acessoExpirado": false,
    "organizacao": {
        "id": "dbff67ca-4f2a-11ea-b77f-2e728ce88125",
        "tenant": 1,
        "schema": "schema1",
        "nome": "Minha Empresa Ltda",
        "modulos": [
            "DOCUMENTOS_DIGITAIS"
        ],
        "plano": {
            "id": "57d49fb1-3b22-43e1-aa0c-fb1264dfc085",
            "descricao": "Grátis",
            "usuarios": 1,
            "armazenamento": 10,
            "documentosMensais": 3,
            "contasFinanceiras": 2,
            "vendasMensais": 5,
            "nfeMensais": 0,
            "boletosMensais": 0,
            "suporteChat": false,
            "valor": 0
        },
      "fiscal": {
      	"serie": 558",
        "certificado": {
      		"nome": "Nome doc ertificado",
        	"vencimento": "2020-13-15"
      	},
      }
    },
    "recursos": [
        {
            "identificacao": "ESTADOS",
            "permissoes": [
                {
                    "identificacao": "VISUALIZAR"
                }
            ]
        },
        {
            "identificacao": "MUNICIPIOS",
            "permissoes": [
                {
                    "identificacao": "VISUALIZAR"
                }
            ]
        },
        {
            "identificacao": "PAISES",
            "permissoes": [
                {
                    "identificacao": "VISUALIZAR"
                }
            ]
        },
        {
            "identificacao": "PRODUTOS",
            "permissoes": [
                {
                    "identificacao": "EDITAR"
                },
                {
                    "identificacao": "EXCLUIR"
                },
                {
                    "identificacao": "INSERIR"
                },
                {
                    "identificacao": "VISUALIZAR"
                }
            ]
        }
    ],
    "setores": [
        {
            "id": "dbff6e64-4f2a-11ea-b77f-2e728ce88125",
            "nome": "Geral"
        }
    ],
    "configuracoes": [
        {
            "chave": "MOSTRAR_AJUDA",
            "valor": "SIM"
        },
        {
            "chave": "TEMA",
            "valor": "AZUL"
        }
    ]
}

Salvar configuração da credencial

Este recurso salva uma configuração para a credencial atual logada.

Exemplo de requisição

{
	"chave": "TEMA",
	"valor": "AZUL"
}

Listar configurações da credencial

Este recurso lista as configurações da credencial logada.

Exemplo de resposta

[{
		"chave": "MOSTRAR_AJUDA",
		"valor": "SIM"
	},
	{
		"chave": "TEMA",
		"valor": "AZUL"
	}
]