Obter dados chavePasse

1 Orientações gerais
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

Orientações gerais

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/chavePasse`	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

IMPORTANTE
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

O termo XPTO costuma designar algo genérico para oferecer um exemplo. Seu uso é semelhante ao do “X” (a marca “X”, o produto “X”)

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

Exemplo de Retorno de Sucesso

{
	"status": true,
	"data": {
		"sistema": {
			"sistemaOperacional": {
				"plataforma": "ios",
				"versaoPlataforma": "18.1.1"
			},
			"origem": "mobile",
			"bundle": "br.com.mobilesaude.implantacaosaude",
			"plataformaExecucao": {},
			"localidade": {},
			"instancia_aplicacao": 1,
			"versaoConfigurador": 7
		},
		"negocio": {
			"canalAtendimento": "appMobile",
			"sessionKey": "XPTO",
			"chaveUnica": "XPTO",
			"protocolo": "XPTO"
		},
		"aplicacao": {
			"idFuncionalidade": "9277",
			"idAplicacao": 40,
			"idConfigClienteApp": 51,
			"uuidFuncionalidade": "XPTO",
			"idCliente": 8,
			"idOcorrencia": 6353823,
			"idTipoOcorrencia": "115"
		},
		"dataCriacao": "2024-11-29 20:31:55",
		"dataExpiracao": "2024-11-29 20:41:55"
	},
	"message": "Dados carregados com sucesso.",
	"critical": [],
	"statusCode": 200,
	"timestamp": 1732912328118
}

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
}