Comparação de Páginas

...

Índice

minLevel	1
maxLevel	7

Dica
Só são suportadas integrações no padrão REST.

Nota

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

Nota

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”:

~~Contrato~~
~~contrato~~
~~Contratos~~
contratos

Método de detalheDebito

Dica
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/ demonstrativoPagamento/resumo	POST	application/json	Retorna os dados básicos 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 listaPeriodo.
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

Bloco de código

language	json

url: 
https://www.operadoradesaude.com.br/mobilesaude/demonstrativoPagamento/resumo

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.

...

Atributo	Critério	Tipo	Descrição	Regra de preenchimento
icone	OP	String	icone a ser utilizado no card de alerta. Verifique a lista de icones disponiveis pela mobile.
mensagem	M	String	Informe a mensagem a ser exibida no card de alerta. Consulte o layout	texto livre
cor	OP	String	cor do texto a ser exibida.	Hexadecimal. com o #. da cor que deseja que seja usada na mensagem de alerta

Exemplo retorno API - sucesso

Bloco de código

language	json

{
  "chavePagamento": "55555555:2024-06-01:101010",
  "dataPagamento": "2024-06-01",
  "valorLiquido": 1000,
  "descricao": "Segunda quinzena",
  "resumo":[
    {
      "codigo":1,
      "descricao":"producao",
      "valor":1000.12,
      "cor":"#FF0000"
    },   
    {
      "codigo":2,
      "descricao":"Outros créditos",
      "valor":800.00,
      "cor":"#FF0000"
    },    
    {
      "codigo":3,
      "descricao":"Impostos",
      "valor":800.00,
      "cor":"#FF0000"
    },
    {
      "codigo":4,
      "descricao":"Outros débitos",
      "valor":800.00,
      "cor":"#FF0000"
    }
  ],
  "observacao": "pagamento pode ocorrer até dois dias úteis após o vencimento"
  "alerta": {
    "icone": "icon_boleto_calendar",
    "cor": "#FF0000",
    "mensagem": "Sua cobrança está programada para cartão de crédito. Caso queira pagar agora, basta clicar para gerar um boleto."
  },
}

Descrição dos objetos e atributos de retorno - falha

Aviso
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;

...

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

Bloco de código

language	json

{
  "mensagem": "Não foi possível obter os detalhes deste débito. Por favor, entre em contato com suporte."
}

Ícones disponíveis (.png)

icon_boleto_calendar	icon_boleto_card	icon_boleto_check
icon_boleto_exclamation	Icon_boleto_exclude	icon_boleto_money
icon_boleto_notification	icon_boleto_star