| Índice | ||||
|---|---|---|---|---|
|
| Dica |
|---|
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/sistema
| Dica |
|---|
|
End-point
Endpoint | Método | Header Content-Type |
|---|
Descrição
| GET | application/json |
Carrega os dados de sistema pela chave passe.
...
Headers
Parâmetro |
|---|
Obrigatório | Tipo | Descrição |
|---|
Authorization | M |
String
URL de origem que faz o request para a API
...
token do cliente | Como obter Em “APIs” coloque a opção “chavePasse” para gerar o token. |
Parâmetros de QueryString
Parâmetro |
|---|
Requerido | Tipo | Descrição |
|---|---|---|
instanciaApp |
Sim | String |
Sandbox == 1 | |
chavePasse |
Sim | String | Chave Passe |
recebida via QueryString no redirecionamento para a URL configurada. |
chaveFuncionalidade |
Sim | String |
Campo chave gerada automaticamente no cadastro da funcionalidade customizada e disponível no Painel Mosia OmniChannel. |
Exemplo de Request
| Bloco de código | ||
|---|---|---|
| ||
curl --request GET \ --url 'https://api.mosiaomnichannel.com.br/clientes/chavePasse/sistema?instanciaApp=XPTO&chavePasse=XPTO&chaveFuncionalidade=XPTO' \ --header 'Authorization: XPTO' |
Exemplo de Retorno de Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"status": true,
"data": {
"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
}
},
"message": "Dados carregados com sucesso.",
"critical": [],
"statusCode": 200,
"timestamp": 1644936972579
}
|
Exemplo de Retorno de Falha
| Bloco de código | ||
|---|---|---|
| ||
{
"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