Conheça os formatos de integração disponíveis em nossa plataforma

Owned by Jean Schulz
Last updated: ago. 24, 2020
4 min read

Objetivo geral

Nessa documentação a Mobile Saúde abordará todos os modelos de integração disponíveis para a Plataforma do Beneficiário. 

O entendimento do formato de integração é fundamental para a implantação do projeto. 

Para realizar uma implantação do produto padrão, a adoção dos padrões de integração é imprescindível.

Não seguir o padrão de integrações documentado levará o projeto IMEDIATAMENTE para um projeto ESPECÍFICO, com horas abertas, e tempo de duração muito maior. 


O processo de instalação:

Para que sua empresa tenha acesso a uma ou mais funcionalidades do padrão do produto, existe um fluxo de processos que consiste - de forma resumida - em:

  1. Cliente: Adquirir o direito de uso da funcionalidade padrão (via departamento comercial);
  2. Mobile Saúde e cliente: Kick-off do projeto (através do time comercial e entrega) e início formal da implantação;
  3. Cliente: Entendimento de como funciona a feature contratada (de onde os dados são obtidos, como é exibido, interações, etc);
  4. Cliente: Implementação das integrações ou configurações por parte do cliente (com base nos manuais da mobile saúde ou integrações disponíveis no padrão);
  5. Mobile Saúde: validar as integrações / fornecer app de homologação para validação
  6. Cliente: utilizando o app, validar as funcionalidades contratadas;
  7. Mobile Saúde: atualizar apps nas lojas oficiais, quando necessário, para liberar as novas features para os beneficiários.

Conhecendo as integrações:

Quando uma funcionalidade nova é implantada, podem ser necessárias integrações.

Essas integrações devem obedecer o formato e layout designado pela Mobile Saúde, para que possamos garantir o bom funcionamento, além de desempenho e alta disponibilidade.

Cada funcionalidade tem integrações, diferentes. Alguns exemplos de integrações existentes:

  • Rede credenciada no app e na web: necessita de carga de dados de rede credenciada, no formato CSV, com layout de campos pré-definidos em documentação da Mobile Saúde;
  • Cartão virtual: exige a criação de integrações para realizar login e recuperar senha, por exemplo.
  • Extratos de utilização: necessita de um webservice capaz de entregar as utilizações do usuário logado, em determinado período.
  • Solicitação de atualização cadastral: sua empresa pode implementar um método que receberá os dados fornecidos pelo beneficiário, e grava-los diretamente na base de dados de seu sistema gestor de planos de saúde.

Iniciando o trabalho:

Uma vez que sua empresa tenha definido o escopo da implantação, é hora de entender que tipo de integração deve ser implementada.

Integrações disponíveis:

  • CMS - Gerenciador de conteúdo: sua empresa acessa o painel de gestão do app (usando usuário/senha fornecido pela Mobile Saúde). Lá, sua empresa configura o conteúdo e comportamento da aplicação, e o app reflete a mudança realizada
  • Arquivos Batch CSV: sua empresa gera arquivos de carga (batch) e realiza o upload dos dados utilizando um painel de importação web, ou rotina automatizada (SFTP)
  • APIs (REST): integração online utilizando Webservices padrão REST, onde sua empresa desenvolve integrações no padrão REST, conforme layout de integração pre-definido;
  • Webhook: atualizações de dados originadas pela Mobile Saúde, quando recebemos uma solicitação vinda do usuário (como por exemplo uma solicitação de atualização cadastral);
  • N/A: quando não existe integração, utilizamos o formato "N/A" que significa não se aplica.

A tabela abaixo identifica cada funcionalidade, e como funciona o critério de integração (quando existente):


FuncionalidadeApps (iOS e Android)Área do beneficiárioObservações
NotíciasCMSCMS
BannersCMSCMS
Revistas e manuaisCMSCMS
AlarmesN/AN/A
Prescrições (foto)N/AN/A
Busca de rede credenciadaArquivos Batch CSVArquivos Batch CSVEnviar set de arquivos que compõem a carga de dados
Prestadores favoritosN/AN/AFuncionalidade exclusiva para apps, utiliza-se da carga de dados de rede credenciada
DescredenciadosArquivos Batch CSVArquivos Batch CSVMesmos arquivos da Busca de rede credenciada
Livreto em PDFN/AArquivos Batch CSV + CMSOperadora configura a capa, contracapa, e introdução no CMS. O conteúdo dos livretos em PDF são gerados automaticamente, a cada nova carga de dados de rede credenciada
Autenticação de usuários no appAPIs (REST)APIs (REST)

Métodos padrões disponíveis:

  • Login
  • Troca de senha
  • Novo usuário
  • Recuperar senha
  • Recuperar número de cartão


Extrato de utilização e coparticipaçãoAPIs (REST)APIs (REST)

Métodos: 

  • Extrato 


Débitos (Boletos)APIs (REST)APIs (REST)

Métodos:

  • Lista de declarações
  • Detalhes da declaração


Extrato de autorizaçõesAPI (REST)APIs (REST)

Métodos:

  • Status de autorização
  • Extrato de autorização
  • Detalhe de autorização
  • PDF 


Extrato de reembolsoAPIs (REST)APIs (REST)

Métodos:

  • Status reembolso
  • Extrato de reembolso (lista)
  • Detalhes reembolso
  • Histórico reembolso


Solicitação de 2a via de cartãoCMS +  WebhookCMS +  Webhook

Formato:

  • Usuário do app acessa funcionalidade
  • Faz a solicitação
  • Grava na base da mobile saúde (acessível via CMS)
    • Cliente pode analisar direto no CMS, rejeitando, aprovando
    • Cliente pode utilizar webhook + API para gravar direto as solicitações em seus sistemas;
      • Quando houver atualização da solicitação no sistema gestor do cliente, o sistema do cliente atualiza a base da Mobile Saúde através de API.


Solicitação de atualização cadastral CMS +  WebhookCMS +  Webhook

Formato:

  • Usuário do app acessa funcionalidade
  • Faz a solicitação
  • Grava na base da mobile saúde (acessível via CMS)
    • Cliente pode analisar direto no CMS, rejeitando, aprovando
    • Cliente pode utilizar webhook + API para gravar direto as solicitações em seus sistemas;
      • Quando houver atualização da solicitação no sistema gestor do cliente, o sistema do cliente atualiza a base da Mobile Saúde através de API.


Solicitação de cancelamento de planoN/ACMS + Webhook

Formato:

  • Usuário do app acessa funcionalidade
  • Faz a solicitação
  • Grava na base da mobile saúde (acessível via CMS)
    • Cliente pode analisar direto no CMS, rejeitando, aprovando
    • Cliente pode utilizar webhook + API para gravar direto as solicitações em seus sistemas;
      • Quando houver atualização da solicitação no sistema gestor do cliente, o sistema do cliente atualiza a base da Mobile Saúde através de API.


Mosia Chat CMS +  WebhookCMS + Webhook

Rotina de Chat online no app utiliza-se de credenciais de login para identificar o usuário que está chamando.

A cada mudança de status no processo de chat (em fila, sendo atendido, encerrado, etc) a Mobile Saúde dispara um webhook para o cliente.

O cliente define em que status deseja atualizar seus sistemas

Mosia FAQ CMSCMSCMS específico para o FAQ
Agendamento onlineAPIs (REST)APIs (REST)
Mosia TelecareAPIs (REST) + CMSAPIs (REST) + CMS

Agendamento online + Rede própria: utiliza-se de APIs integradas ao cliente

Disponibilização de ferramenta para rede contratualizada: utiliza-se de Gerenciador de conteúdo para que os médicos de rede cadastrem suas agendas, etc.

MensageriaAPIs (REST) + CMSAPIs (REST) + CMS

Painel que permite importar mensagens, contatos, e enviar mensagens individuais ou em grupo, assim como emitir relatórios de envios e faturamento.

APIs disponíveis para ações de envio de mensagens individuais, ou em grupo.


Tanto API quanto painel permitem envios de mensagens SMS e IN-APP.






Você vai perceber, ao longo deste documento, que existem 3 formatos de integração disponíveis:

  • Carga de dados via arquivos CSV (utilizados essencialmente para carga de rede credenciada);
  • Integrações "por demanda" através de webservices padrão REST: utilizados em funcionalidades muito dinâmicas, como login, troca de senha, extrato de uso, declarações de IR, etc.
  • Gerenciador de conteúdo e webhook / API: 




Mobile Saúde - 2019