Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 15 Próxima »

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/usuario

End-point

Endpoint

Método

Header Content-Type

Descrição

/chavePasse/usuario

GET

application/json

Carrega os dados do usuário através da 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": {
        "sistema": {
            "sistemaOperacional": {
                "plataforma": "android",
                "versaoPlataforma": "12"
            },
            "origem": "web",
            "bundle": "br.com.mosiaomnichannel.sandbox.mosiatesting",
            "plataformaExecucao": {
                "navegador": null,
                "versaoNavegador": null
            },
            "localidade": {
                "latitude": 121212.12,
                "longitude": 121212.23
            }
        },
        "negocio": {
            "canalAtendimento": "",
            "sessionKey": "20472cddf04f56bf6def70e0d6163ac908a0ead452f80dd476d370724785e2b8",
            "chaveUnica": "everson@mobilesaude.com.br"
        },
        "aplicacao": {
            "idFuncionalidade": "9013",
            "idAplicacao": 40,
            "idConfigClienteApp": 200,
            "uuidFuncionalidade": "b80918fe-680d-4f49-ba02-6659256f4de0",
            "idCliente": 409
        },
        "dataCriacao": "2022-02-15 14:48:39",
        "dataExpiracao": "2022-02-15 14:58:39"
    },
    "message": "Dados carregados com sucesso.",
    "critical": [],
    "statusCode": 200,
    "timestamp": 1644936902465
}

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
}

  • Sem rótulos