Obter dados do grupo familiar pela chave passe

Só são suportadas integrações no padrão REST.

Orientações

Parâmetros de entrada

Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.

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

Método /chavePasse/grupoFamiliar

Atente-se as orientações fornecidas pela Mobile Saúde;
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;

End-point

Endpoint	Método	Header Content-Type	Descrição
`/chavePasse/grupoFamiliar`	GET	application/json	Carrega os dados do grupo familiar pela chave passe.

Parâmetros de header

Parâmetro	Obrigatoriedade	Tipo	Descrição
origem	M	String	URL de origem que faz o request para a API

A origem deve estar previamente cadastrada no Painel Público - Segurança - Cadastro de Origens.

Parâmetros de QueryString

Parâmetro	Obrigatoriedade	Tipo	Descrição
instanciaApp	M	String	bundle da aplicação ofuscado (BASE64)
chavePasse	M	String	Chave Passe que foi gerada.
chaveFuncionalidade	M	String	UUID chave da funcionalidade.

Exemplo de Retorno de Sucesso

{
    "status": true,
    "data": [
        {
            "chaveUnica": "Geraldo@mobilesaude.com.br",
            "nome": "Geraldo Felix Junior",
            "tipoUsuario": {
                "codigo": "T",
                "descricao": "Titular"
            },
            "numeroCartao": "00010002000001000",
            "integracao": {
                "numero_cartao_benef": "00010002000001000",
                "cpf_benef": "07805206708",
                "abcdef": 9288701
            }
        }
    ],
    "message": "Dados carregados com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1644936999741
}

Exemplo de Retorno de Falha

{
    "status": false,
    "data": [],
    "message": "Ocorreu uma falha interna no servidor. Por favor tente novamente mais tarde.'",
    "critical": [
        {}
    ],
    "statusCode": 403,
    "timestamp": 1635347170840
}