Índice
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 |
Objetos e atributos de retorno
Os atributos devem seguir exatamente os mesmos nomes indicados nesta documentação, caso contrário, serão rejeitados pelo validador de integração.
Exemplo do atributo “contratos”:
ContratocontratoContratoscontratos
Método de gerarBoleto
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;
Endpoint
Endpoint | Método | Header Content-Type | Descrição |
|---|---|---|---|
http://exemplo.com /gerarBoleto
| POST | application/json | solicitar ao cliente a geração de um boleto de pagamento para o cliente. |
Parâmetros de entrada
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
idTitulo | M | Number | Id de banco de dados da título no seu sistema interno. |
codigoTitulo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu do atributo codigoTitulo do método listaDebito |
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
integracao | OP | Objeto | Nó integração retornado no login do usário |
Exemplo request
url:
https://www.operadoradesaude.com.br/mobilesaude/gerarBoleto
Body:
{
"chaveUnica": "101012",
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"idTitulo": 579,
"codigoTitulo": "MS00579"
}
Descrição dos objetos e atributos de retorno - Sucesso
Está indicado abaixo a estrutura de retorno do seu método login. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
linhaDigitavel | M | String | linha digitavel completa sem pontos ou tracos | texto livre |
informacoes | OP | String | informações pertinentes ao boleto | texto livre |
Exemplo retorno API - sucesso
{
"linhaDigitavel": "2147483647",
"informacoes": "Minima et sit iste dolores. "
}
Descrição dos objetos e atributos de retorno - falha
Está indicado abaixo a estrutura de retorno do seu método listaDebitos. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
Atente-se as mensagens de retorno para cada HTTPS Status Code;
Objetos e atributos de retorno
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
mensagem | M | String | mensagem para ser exibida para o cliente | texto livre |
Exemplo retorno API - falha
{
"mensagem": "Não foi possível obter os detalhes deste débito. Por favor, entre em contato com suporte."
}