Í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 resumoCobranca
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 |
|---|---|---|---|
exemplo.com/demonstrativoPagamento/detalhe | POST | application/json | Retorna os detalhes do demonstrativo de pagamento referente ao período selecionado |
Parâmetros de entrada
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
chavePagamento | M | String | Chave de identificação do período selecionado. Essa informação é retornada pelo método resumo. |
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
integracao | OP | Objeto | Nó integração retornado no login do usuário |
Exemplo request
url:
https://www.operadoradesaude.com.br/mobilesaude//demonstrativoPagamento/detalhe
Body:
{
"chaveUnica" : "101012",
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"chavePagamento": "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 |
|---|---|---|---|---|
titulo | M | String | Informe o titulo de apresentação do período de pagamento, por exemplo: “Primeira quinzena“; “Segunda quinzena“; “Pagamento mensal” | |
subtitulo | M | String | Informe o subtitulo do periodo, por exemplo: competência de pagamento | |
tituloTotalizador | M | String | titulo totalizador dos registros de produção | texto livre |
valorTotal | M | Float | valor total liquido a receber |
|
dataPagamento | M | String | Data de Pagamento | Formato: Formato: YYYY-MM-DD |
registros | M | Array | Array de objetos do tipo "registro" |
|
Objeto registro
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
titulo | M | String | Titulo do agrupador de registros | |
icone | OP | String |
| |
cor | OP | String | cor do agrupador | Hexadecimal. com o #. da cor que deseja que seja usada para representar o agrupador. |
valorTotal | M | Float | Valor total do registro |
|
valores | M | Array | Array de objetos do tipo "valor" |
|
Objeto valor
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
codigo | M | String | identificador | texto livre |
descricao | M | String | Descrição | texto livre |
valor | M | Float | Valor |
|
Exemplo retorno API - sucesso
{
"titulo": "Pagamento Mensal",
"subtitulo": "2024-08",
"tituloTotalizador": "Mensalidade",
"valorTotal": 1257.99,
"dataPagamento": "2024-08-01",
"registros": [
{
"titulo": "Créditos",
"icone": "icon_plus",
"cor":"#FF0000",
"valorTotal": 442.1,
"valores": [
{
"codigo": "101",
"descricao": "Produção",
"valor": 12029.8
},
{
"codigo": "105",
"descricao": "Repasse Particulares",
"valor": 1200.9
}
]
},
{
"titulo": "Débitos",
"icone": "icon_minus",
"cor":"#FF0000",
"valorTotal": 442.2,
"valores": [
{
"codigo": "101",
"descricao": "Imposto de Renda",
"valor": 12029.8
},
{
"codigo": "105",
"descricao": "INSS",
"valor": 1200.9
}
]
},
{
"titulo": "Outras informações",
"subtitulo": "Produção do periodo organizada por outros parâmetros, Mais informações no relatório analítico.",
"cor":"#FF0000",
"valorTotal": 442.2,
"valores": [
{
"codigo": "101",
"descricao": "Crédito",
"valor": 12029.8
},
{
"codigo": "101",
"descricao": "Capitalização",
"valor": 12029.8
},
{
"codigo": "101",
"descricao": "Deduções autorizadas",
"valor": 12029.8
},
{
"codigo": "101",
"descricao": "Deduções legais",
"valor": 12029.8
}
]
}
]
}
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": "Resumo de cobrança não encontrado!"
}