Versões comparadas

Version Versão antiga 2 Nova versão Atual
Alterações feitas por

Emerson Herzeg

Ranniêr Reis

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Dica

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

Nota

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

Índice
minLevel1
maxLevel7

Orientações

Dica

End-point

Endpoint

Método

Header Content-Type

Descrição

https://api.mosiaomnichannel.com.br/clientes/chavePasse/grupoFamiliar

GET

application/json

Carrega os dados do grupo familiar pela chave passe

Headers

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

Obrigatoriedade

Requerido

Tipo

Descrição

origem

M

String

URL de origem que faz o request para a API

...

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

Bloco de código
languagebash
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

Bloco de código
languagejson
{
    "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

Bloco de código
languagejson
{
    "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

https://mobilesaudejira.atlassian.net/wiki/spaces/MO/pages/2463989776/API+de+Acesso+a+Dados#Exemplo