1.8 - Relogin
- 1 Introdução
- 2 Segurança e permissões
- 3 Critérios de preenchimento
- 4 Objetos e atributos de retorno
- 5 Método - Relogin
- 6 Endpoint
- 7 Parâmetros Utilizados
- 8 Funcionamento do Processo de Re-Login
- 9 Chave de Segurança
- 10 Fluxo do Re-Login e Exemplos de APIs
- 10.1 Fluxo do Re-Login
- 11 Configurando Relogin no Mosia Omnichannel
Só são suportadas integrações no padrão REST.
Introdução
O processo de re-login é uma funcionalidade implementada na aplicação que permite atualizar os dados de login do beneficiário em determinados intervalos de tempo, sem a necessidade de efetuar um novo login completo. Essa funcionalidade melhora a experiência do usuário, permitindo que ele permaneça logado por um período prolongado sem a necessidade de autenticação repetida. O relogin utiliza um token de segurança para validar a sessão do usuário e pode ser configurado com base em parâmetros específicos.
Segurança e permissões
Tokens de segurança ou autenticação
A Mobile Saúde descreve nesta documentação o formato de adoção obrigatória quando sua empresa desejar utilizar TOKENS de segurança.
O formato suportado pela aplicação está descrito no objeto SEGURANÇA, e sua empresa deve necessariamente implementa-lo conforme descrito quando desejar utilizar essa camada adicional de segurança.
Não serão suportadas outras formas de transacionar TOKENs de segurança, como por exemplo tokens de autenticação na URL da requisição, entre outros.
Caso tenha dúvidas, ou deseje maiores esclarecimentos, entre em contato com o gestor de projeto encarregado de sua implantação, para atendimento às questões ANTES DE DESENVOLVER SUA API.
Objeto permissões
Devemos somente informar na estrutura de permissões dentro do objeto contratos as funcionalidades que o usuário não tem acesso ou ocultar caso queira que não apareça, mas para requisito de validação da estrutura do beneficiário, eleger uma ou mais funcionalidades junto com a equipe de desenvolvimento da Mobile Saúde para facilitar os testes de permissionamento.
Lembrando que a tabela de funcionalidades está no final do documento de especificações.
Exemplos de uso:
Funcionalidade negada com mensagem customizada
"permissoes": [ {
"funcionalidade": "1",
"acesso": false,
"mensagemBloqueio": "Você não possui acesso a está funcionalidade, para mais informações entre em contato com 0800",
"ocultar": false
}]
Funcionalidade negada sem mensagem customizada, será exibida uma mensagem padrão
"permissoes": [ {
"funcionalidade": "1",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": false
}]
Funcionalidade oculta no app
"permissoes": [ {
"funcionalidade": "1",
"acesso": false,
"mensagemBloqueio": null,
"ocultar": true
}]
Acesso liberado
"permissoes": null
Critérios de preenchimento
Abreviação | Nome | Descrição |
|---|---|---|
M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
Objetos e atributos de retorno
Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.
Exemplo do atributo "usuarioLogado":
usuario-logado
usuario_logado
usuario
usuarioLogado
Método - Relogin
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
POST | application/json | Endpoint de relogin |
Parâmetros de entrada
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
chave_unica | M | String | ID de identificação do usuário do app. Sugerimos que o login seja o CPF do usuário. |
integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. Deve existir um objeto idêntico para um dos beneficiários no array " |
Exemplo request
url:
https://www.operadoradesaude.com.br/mobilesaude/relogin
Body:
{
"chaveUnica": "<chave_unica>"
"integracao":{
""chaveUnica" " : "chaveUnica",
""chave_unica" " : "chave_unica"
}
}
Descrição dos objetos e atributos de retorno - Sucesso
Parâmetros Utilizados
utilizaRelogin
O parâmetro utilizaRelogin define se o App entra ou não no fluxo de relogin, que é controlado pelos demais parâmetros listados abaixo e a integração de Relogin. O seu valor default é falso.
reloginIntervaloSolicitaMinutos
O parâmetro reloginIntervaloSolicitaMinutos define o intervalo de tempo no qual o aplicativo irá solicitar um novo re-login. Ele determina o tempo entre as verificações de re-login para determinar se o beneficiário precisa fazer uma nova autenticação. Por exemplo, se o valor for definido como 60 minutos, o aplicativo solicitará um re-login se o último login tiver ocorrido há mais de uma hora.
reloginNumeroMaximoFalhas
O parâmetro reloginNumeroMaximoFalhas define o número máximo de falhas permitidas na solicitação de re-login. Caso o beneficiário falhe em realizar um re-login bem-sucedido por um determinado número de vezes consecutivas, o usuário será automaticamente deslogado do aplicativo por motivos de segurança.
reloginPeriodoMaximoSemReloginMinutos
O parâmetro reloginPeriodoMaximoSemReloginMinutos define o período máximo em que o beneficiário pode permanecer logado sem executar um novo re-login. Ele determina o tempo máximo permitido para que o usuário permaneça autenticado no aplicativo sem a necessidade de realizar uma nova autenticação. Se esse período for ultrapassado, o usuário será deslogado automaticamente para garantir a segurança da sessão.
ReloginIntervaloExecucaoEmHoras
O parâmetro ReloginIntervaloExecucaoEmHoras define o intervalo de tempo em que a função de relogin automático do aplicativo será executada. Esse intervalo determina a frequência com que o aplicativo verificará se é necessário realizar o re-login, de acordo com o valor configurado.
Funcionamento do Processo de Re-Login
O processo de re-login é implementado da seguinte maneira:
Registro da Data de Login
Ao efetuar o login no aplicativo, a data e hora do login são registradas. Isso serve como referência para as verificações subsequentes de re-login.
Verificação de Intervalo de Tempo
Cada vez que o beneficiário fecha e reabre o aplicativo, o sistema verifica o parâmetro reloginIntervaloSolicitaMinutos e compara com a data do último login. Se o tempo decorrido desde o último login ultrapassar o valor definido pelo parâmetro, o aplicativo solicita um novo re-login.
Tratamento de Falhas de Relogin
Se a solicitação de re-login falhar, o sistema registra essa falha e conta o número de tentativas sem sucesso. Se o número de tentativas sem sucesso atingir o valor definido pelo parâmetro reloginNumeroMaximoFalhas, o beneficiário será deslogado automaticamente do aplicativo por motivos de segurança.
Tempo Máximo sem Relogin
Além disso, o parâmetro reloginPeriodoMaximoSemReloginMinutos define o período máximo permitido para o beneficiário permanecer logado sem executar um novo re-login. Se esse período for ultrapassado, o aplicativo deslogará o usuário automaticamente para garantir a segurança da sessão.
Chave de Segurança
A chave de segurança é um elemento crucial no processo de re-login. Ela é utilizada para garantir a integridade e autenticidade da sessão do usuário. A chave de segurança pode ser uma chave fixa compartilhada entre o aplicativo e o servidor ou pode ser gerada dinamicamente com um tempo de vida específico. Em implementações mais avançadas, recomenda-se o uso de um token temporário, que é renovado periodicamente para manter a segurança.
Fluxo do Re-Login e Exemplos de APIs
Fluxo do Re-Login
O fluxo geral do processo de re-login é o seguinte:
O beneficiário realiza o login no aplicativo.
A data do login é registrada.
Ao fechar e reabrir o aplicativo, o sistema verifica o intervalo de tempo definido pelo parâmetro reloginIntervaloSolicitaMinutos.
Se o intervalo de tempo for ultrapassado, o sistema solicita um novo re-login.
Se o re-login for bem-sucedido, a sessão é renovada e o beneficiário permanece logado.
Se o re-login falhar ou o número máximo de tentativas for atingido, o beneficiário é deslogado do aplicativo.
Se o período máximo sem re-login for ultrapassado, o beneficiário é deslogado automaticamente.
Configurando Relogin no Mosia Omnichannel
Para configurar o relogin é necessário:
Acessar o configurador público (caso não saiba como acessar, clique aqui )
“Opções de logins”
“Login”
“Integrações”
“Relogin” > “Editar”
6. Valide seus dados no validador de integrações e o seu relogin estará implementado.