Dica |
---|
Só são suportadas integrações no padrão REST. |
Nota |
---|
OrientaçõesParâmetros de entradaSerã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. |
Parâmetros de header
Parâmetro | Obrigatoriedade | Tipo | Descrição |
---|---|---|---|
origem | 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. |
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
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
} |