Obter dados grupoFamiliar

1 Orientações
2 End-point
3 Headers
- 3.1 Parâmetros de QueryString
- 3.2 Exemplo de Request
- 3.3 Exemplo de Retorno de Sucesso
- 3.4 Exemplo de Retorno de Falha
4 Exemplo em vídeo

Orientações

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

Endpoint	Método	Header Content-Type
`https://api.mosiaomnichannel.com.br/clientes/chavePasse/grupoFamiliar`	GET	application/json

Headers

Parâmetro	Obrigatório	Tipo	Descrição

Parâmetro

Obrigatório

Tipo

Descrição

Authorization

M

token do cliente

Como obter
Token de autenticação do cliente

Em “APIs” coloque a opção “chavePasse” para gerar o token.

Parâmetros de QueryString

Parâmetro	Requerido	Tipo	Descrição

Parâmetro

Requerido

Tipo

Descrição

instanciaApp

Sim

String

Sandbox == 1
Produção == 2

chavePasse

Sim

String

Chave Passe recebida via QueryString no redirecionamento para a URL configurada.

Como obter chavePasse

chaveFuncionalidade

Sim

String

Campo chave gerada automaticamente no cadastro da funcionalidade customizada e disponível no Painel Mosia OmniChannel.

Como obter chaveFuncionalidade

Exemplo de Request

curl --request GET \
  --url 'https://api.mosiaomnichannel.com.br/clientes/chavePasse/grupoFamiliar?instanciaApp=XPTO&chavePasse=XPTO&chaveFuncionalidade=XPTO' \
  --header 'Authorization: XPTO'

Exemplo de Retorno de Sucesso

{
    "status": true,
    "data": [
        {
            "chaveUnica": "teste@teste.com.br",
            "nome": "José Antonio Moreira",
            "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
}

Exemplo em vídeo

API de Acesso a Dados | Exemplo