| Índice | ||||
|---|---|---|---|---|
|
Orientações gerais
| 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
...
|
End-point
Endpoint | Método | Header Content-Type |
|---|---|---|
| GET | application/json |
Headers
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
Authorization | M | token do cliente | Como obter IMPORTANTE |
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/usuario?instanciaApp=XPTO&chavePasse=XPTO&chaveFuncionalidade=XPTO' \
--header 'Authorization: XPTO' |
Exemplo de Retorno de Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"status": true,
"data": {
"chaveUnica": "teste@teste.com",
"integracao": {
"numero_cartao_benef": "00010002000001000",
"cpf_benef": "92188083970",
"abcdef": 9288701
}
},
"message": "Dados carregados com sucesso.",
"critical": [],
"statusCode": 200,
"timestamp": 1644936988177
} |
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