1.3.1 - Identificação do usuário
- Ranniêr Reis
- Jean Schulz
Índice
Só são suportadas integrações no padrão REST.
Orientações
Formulário dinâmico criado pelo Formbuilder. A aplicação fica responsável por encaminhar o formulário informado para o método. Os parâmetros de entrada devem ser devidamente informados no formulário de autenticação utilizado no configurador de integração.
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.
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 "contatos":
contatos-beneficiario
contatos_beneficiario
contato
contatos
Método - Recuperar Senha Identificação
Este método tem como objetivo a identificação do usuário por meio de um formulário;
Atente-se as orientações fornecidas pela Mobile Saúde;
Atente-se as orientações de segurança e permissões;
Atente-se aos critérios de preenchimento;
Atente-se aos critérios de objetos e atributos de retorno;
Atente-se as mensagens de retorno para cada HTTPS Status Code;
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
/recuperarSenhaIdentificacao | POST | application/json | Endpoint de identificação do cliente |
Exemplo request
url:
https://www.operadoradesaude.com.br/mobilesaude/recuperarSenhaIdentificacao
boby:
{
"cpf": "54430070768",
"dataNascimento":"1993-08-05"
}
Descrição dos objetos e atributos de retorno - Sucesso
Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
integracao | OP | Objeto integracao | Informações necessárias para realizar a identificação do beneficiário no sistema. | Não possui regra de preenchimento, pode ser enviada qualquer estrutura desde que seja uma estrutura JSON valida |
chaveUnica | M | String |
|
|
contatos | M | Array de objetos de "contato" | Indique ao menos um contato que está vinculado ao usuário. | Deve-se ter no mínimo 1 ocorrência válida,. |
seguranca | OP | Objeto seguranca | Lista parâmetros que devem ser enviados no header dos demais endpoints de integração do sistema para garantir que o beneficiário está autenticado no sistema. | Preencher com o objeto do tipo "seguranca". Se não for utilizar não informar, ou informar com o valor "NULL" |
Objeto “contato”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
id | M | String | id de identificação do contato | ASCII (nao permite especiais) |
contato | M | String | informe o contato |
|
tipo | M | Number | informe o tipo de contato | Conteúdo válido: |
ofuscado | OP | string | informe o contato no formato ofuscado. | Se não enviado a Mobile Saúde ofusca no padrão da empresa |
Objeto “seguranca”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
auth | M | Array de objetos “auth” | Lista parâmetros que devem ser enviados no header dos demais endpoints de integração do sistema para garantir que o beneficiário está autenticado no sistema. | Objeto auth valido |
Objeto “auth”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
chave | M | String | Nome do parâmetro no header aonde será enviado o valor da propriedade | ASCII (nao permite especiais) |
token | M | String | Valor do token que será enviado no header, em caso de tokens no padrão | Formato: Texto livre |
expiracao | OP | Number | Caso o token tenha data de expiração, deve ser retornado nessa propriedade o timestamp da data na qual o token irá expirar. | Timestamp (em milissegundos) |
Exemplo retorno API - sucesso
{
"chaveUnica": "10102",
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"contatos": [
{
"id": "1",
"contato": "benef@gmail.com",
"tipo": 1,
"ofuscado": "b****f@g***.com"
},
{
"id": "2",
"contato": "benef@outlook.com",
"tipo": 1,
"ofuscado": null
},
{
"id": "3",
"contato": "27997157620",
"tipo": 2,
"ofuscado": "279***76**"
}
],
"seguranca": {
"auth": [
{
"chave": "Authorization-Custom",
"token": "JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NzI5ODQ4MzgsIm5iZiI6MTU3Mjk4NDgzOSwiZXhwIjoxNTczMDI4MDM4LCJkYXRhIjp7ImxvZ2luIjoiZGVybGFuZHlAbW9iaWxlc2F1ZGUuY29tLmJyIn19.dzJOQhSG8pJx-l6WDDgMVszFsKB26PsIjF4rB1TnWrk",
"expiracao": 1574366666921
}
]
}
}
Descrição dos objetos e atributos de retorno - falha
Este método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Atente-se as mensagens de retorno para cada HTTPS Status Code;
Objetos e atributos de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagem | M | String | mensagem para ser exibida para o cliente | texto livre |
Exemplo retorno API - falha
{
"mensagem": "Beneficiário não encontrado",
}
Related content
Mobile Saúde - Mosia Omnichannel