1.4 - Grupo familiar - Acesso funcionalidade
- Ranniêr Reis
- Jean Schulz
Índice
Só são suportadas integrações no padrão REST.
Orientações
Neste endpoint o usuário seleciona um dos contatos disponibilizados pelo cliente para realizar o processo de confirmação de identidade.
Objetivo
Esta API é opcional, e quanto implementada, é responsável por controlar a exibição do grupo familiar / contrato em funcionalidades que permitam ao usuário do app escolher “para quem” a funcionalidade se destina.
Caso de uso:
Grupo familiar que possui 3 beneficíarios (1 titular e 2 dependentes)
Contrato 1 - PLANO MÉDICO:
José da Silva (Titular) - 32 anos
Fernanda da Silva (Dependente - esposa) - 30 anos
Gustavo da Silva (Dependente - filho) - 5 anos
Contrato 2 - PLANO ODONTOLÓGICO:
José da Silva (Titular) - 32 anos
Fernanda da Silva (Dependente - esposa) - 30 anos
Gustavo da Silva (Dependente - filho) - 5 anos
Objetivo a ser alcançado:
Exibir na funcionalidade de cartões todos os beneficiários de todos os contratos, porém na funcionalidade de atualização cadastral apenas o contato 1 (PLANO MÉDICO).
O que fazer:
Implementar o método “Acesso funcionalidade”, indicando que:
Quando se tratar da funcionalidade “Cartão virtual” - ID 3 - Devolver todos os beneficiários de todos os contratos
Quando se tratar da funcionalidade “Atualização Cadastral” - ID 16 - Devolver apenas os beneficiários do contrato 1.
O que acontecerá?
No app ou na web, quando o beneficiário logado tocar na função de cartão virtual, a API de acesso funcionalidade será invocada, repassando o ID da funcionalidade + o beneficiário logado.
A API deverá ser implementada para receber o ID e tratar a regra desejada, devolvendo apenas os beneficiários / contratos elegíveis para aquela funcionalidade.
Com base no retorno da API “Acesso funcionalidade”, o app vai exibir apenas os beneficiários elegíveis, ocultando os demais contratos / beneficiários que não tenham acesso àquela funcionalidade.
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 - Grupo familiar
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
/grupoFamiliar | POST | application/json | Endpoint para listar beneficiarios relacionados ao localizador (chaveUnica) que possuem acesso a funcionalidade. |
Parâmetros de entrada
Atributo | Critério | Tipo | Descrição |
|---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
integracao | M | Objeto | nó integração retornado no login do beneficiário |
idFuncionalidade | M | String | Chave de identificação da funcionalidade disponibilizada pela mobile. |
Exemplo request
url:
https://www.operadoradesaude.com.br/mobilesaude/grupoFamiliar
boby:
{
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
},
"chaveUnica": "101012",
"idFuncionalidade": "19"
}
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.
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
contratos | M | Array de objetos”contrato” | Retorna um array de objetos “contratos” | Deve retornar um array de objetos |
Objeto “contratos”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
numeroContrato | M | String | Número que identifica a qual contrato esse beneficiario está vinculado | Texto livre |
beneficiarios | M | Array | Array de objetos do tipo "beneficiario" | Precisa ser preenchido com pelo menos um item |
Objeto “beneficiarios”
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuário retornada no login | Texto livre |
Exemplo retorno API - sucesso
{
"contratos": [
{
"numeroContrato": "001",
"beneficiarios": [
{
"chaveUnica": "10101"
},
{
"chaveUnica": "10102"
},
{
"chaveUnica": "10103"
}
]
},
{
"numeroContrato": "002",
"beneficiarios": [
{
"chaveUnica": "10101"
},
{
"chaveUnica": "10102"
}
]
},
{
"numeroContrato": "003",
"beneficiarios": [
{
"chaveUnica": "10104"
}
]
}
]
}
Lista Funcionalidades
Clique abaixo para ver a relação das funcionalidades existentes na estrutura da Mobile Saúde.
Descrição dos objetos e atributos de retorno - falha
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
Mobile Saúde - Mosia Omnichannel