Tópicos:
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 Solicitação de Autorização, com parâmetros de entrada e retorno.
2- 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.
4- 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.