Versões comparadas

Version Versão antiga 10 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.
Índice
minLevel1
maxLevel7
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

...

Orientações gerais

Dica

End-point

Endpoint

Método

Header Content-Type

Descrição

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

GET

application/json

Carrega os dados do usuário através da chave passe.

...

Headers

Parâmetro

Obrigatoriedade

Obrigatório

Tipo

Descrição

origem

Authorization

M

String

URL de origem que faz o request para a API

Nota

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

...

token do cliente

Como obter
Token de autenticação do cliente

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

Parâmetros de QueryString

Parâmetro

Obrigatoriedade

Requerido

Tipo

Descrição

instanciaApp

M

Sim

String

bundle da aplicação ofuscado (BASE64)

Sandbox == 1
Produção == 2

chavePasse

M

Sim

String

Chave Passe

que foi gerada.

recebida via QueryString no redirecionamento para a URL configurada.

Como obter chavePasse

chaveFuncionalidade

M

Sim

String

UUID

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

Como obter chaveFuncionalidade

Exemplo de

...

Request

{ "status": true, "data": { "sistema":
Bloco de código
languagebash
curl --request GET \
  --url 'https://api.mosiaomnichannel.com.br/clientes/chavePasse/usuario?instanciaApp=XPTO&chavePasse=XPTO&chaveFuncionalidade=XPTO' \
  --header 'Authorization: XPTO'

Exemplo de Retorno de Sucesso

Bloco de código
languagejson
{
            "sistemaOperacional": {
                "plataforma": "android",
         "status": true,
      "versaoPlataformadata": "12"{
            },
            "origem"chaveUnica": "web",
            "bundle": "br.com.mosiaomnichannel.sandbox.mosiatesting",
   teste@teste.com",
        "plataformaExecucaointegracao": {
   
            "navegadornumero_cartao_benef": null,
                "versaoNavegador": null
            }"00010002000001000",
            "localidadecpf_benef": {
                "latitude": 121212.12,
"92188083970",
               "longitudeabcdef": 121212.239288701
            }

       },
   
    "negociomessage": {"Dados carregados     com sucesso.",
      "canalAtendimentocritical": "",
     [],
      "sessionKeystatusCode": "20472cddf04f56bf6def70e0d6163ac908a0ead452f80dd476d370724785e2b8",
     200,
      "chaveUnicatimestamp": "everson@mobilesaude.com.br"
        },
        "aplicacao": {
       1644936988177
}

Exemplo de Retorno de Falha

Bloco de código
languagejson
{
    "idFuncionalidadestatus": "9013",
       false,
    "idAplicacaodata": 40,
       [],
    "idConfigClienteApp": 200,
            "uuidFuncionalidade": "b80918fe-680d-4f49-ba02-6659256f4de0",
            "idCliente": 409
        },
   message": "Ocorreu uma falha interna no servidor. Por favor tente novamente mais tarde.'",
    "dataCriacaocritical": "2022-02-15 14:48:39",[
         "dataExpiracao": "2022-02-15 14:58:39"
    },
 {}
  "message": "Dados carregados com sucesso.",
    "critical": [],
    "statusCode": 200403,
    "timestamp": 1644936902465
}1635347170840
}

Exemplo em vídeo

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