Versões comparadas
Chave
- Esta linha foi adicionada.
- Esta linha foi removida.
- A formatação mudou.
Tópicos:
Índice |
---|
1- Sobre o documento
Descreve o escopo principal da funcionalidade, a integração com os serviços de Callback da Mobile Saúde, padrões de entrada e retorno, parâmetros e protocolos utilizados. A segunda parte do documento lista os endpoints da API de Atualização Cadastral, com parâmetros de entrada e retorno.
1.12- Sobre o escopo da funcionalidade
A funcionalidade tem comportamentos pre definidos, e seu comportamento padrão foi detalhado num passo a passo que ajudará sua operadora a analisar se a funcionalidade padrão tem aderência total ou parcial ao seu fluxo de atendimento ao beneficiário.
3- Definições sobre a plataforma de callback
O callback é uma integração oferecida pela Mobile Saúde, onde é possível cadastrar uma url que servirá de ponto de comunicação entre as APIs da Mobile Saúde e seu sistema, os pontos de entrada serão descritos nesse documento.
1.24- Tentativas de acesso
Caso sua aplicação possua uma url de callback configurada, o sistema da Mobile Saúde realizará uma chamada ao serviço sempre que determinada ação for executada. Toda tentativa de comunicação será logada e novas tentativas poderão ser acionadas pelos administradores.
Se houver algum problema de comunicação ou falha na execução do serviço, a Mobile Saúde executará automaticamente novas tentativas de comunicação.
5- Definições sobre a API
A API documentada, é a mesma utilizada pelos aplicativos, área do beneficiário web e painel administrativo. O parâmetro que identifica sua operadora e também a aplicação contratada se chama "mshash" e deve ser enviado em quase todas as requisições para identificação e segurança. O valor desse parâmetro pode ser encontrado em seu painel administrativo.
2- ATUALIZAÇÃO CADASTRAL
2.1- Endpoint: formulario/submit_formulario
Descrição: Responsável por inserir uma nova solicitação de atualização cadastral para análise, o beneficiário envia seus dados pessoais, correções e alterações de seu cadastro e arquivos de comprovante.
2.2- Como configurar a URL de callback:
Acesse o seu painel administrativo em: painel.tapcore.com.br, no menu lateral busque a funcionalidade: Beneficiário > Atualização Cadastral> ConfiguraçãoPreencha o campo: URL de Callback com a URL que receberá a requisição de callback após inserção de uma nova solicitação de atualização cadastral. 2.3- Especificação do callback da Atualização Cadastral:
Uma particularidade do formulário de atualização cadastral é que ele é dinamicamente configurável, por esse motivo os dados enviados que serão documentados abaixo poderão variar de acordo com o estado atual do seu formulário, mas o padrão se matem.
O callback será feito através de uma requisição HTTP do tipo POST ao serviço cadastrado, os parâmetros serão enviados via RAW no formato JSON, conforme as especificações abaixo:
Pesquisa em tempo real |
---|