Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Método submit_formulario
- Regras de Negocio do Método
- EndPoint
Parâmetros de Entrada do Método
Exemplo
Estrutura de Retorno
- Método atualiza_status_protocolo
- Regras de Negocio do Método
- EndPoint
Parâmetros de Entrada do Método
- Método submit_formulario
- Tela Atualização Cadastral
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela Atualização Cadastral
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
...
Segue os métodos utilizados na API:
- submit_formulario: Inseri uma nova solicitação de atualização cadastral para análise, o beneficiário poderá envia seus dados pessoais, correções e alterações de seu cadastro, além de arquivos de comprovante.
- atualiza_status_protocolo: Atualiza o status de um protocolo de atualização cadastral iniciado. (Esse método é utilizado para enviar o status do TOTVS Saúde Planos Linha Protheus para a Mobile Saúde)
Abaixo será apresentado exemplo do método.
...
Para utilização do método é necessário realizar o de/para da Mobile Saúde com o TOTVS Saúde Planos Linha Protheus, através da rotina De/Para de Integrações (PLIntegDePara), esse cadastro ficará por padrão a partir da release 12.1.2210 na pasta: Atualizações > Integrações > De/Para Integrações (Documentação da Rotina: EM CONSTRUÇÃO)
Segue um exemplo do cadastro de de/para:
...
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| https://<url>:<porta>/rest/mobileSaude/v1/submit_formulario | POST | application/json | Inserir um nova solicitação de atualização cadastral do beneficiário para análise |
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| protocolo | Sim | Caracter | Protocolo da Atualização Cadastral, será gravado no campo BBA_NROPRO da Analise de Beneficiários |
| id_operadora | Sim | Numerico | ID da Operadora na Mobile Saúde |
| mshash | Sim | Caracter | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados na Mobile Saúde. |
| tipo | Não | Caracter | Tipo de beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado). |
| nome | Sim | Caracter | Nome do Beneficiário |
| matricula | Sim | Caracter | Matricula do Beneficiários (Operadora + Empresa + Matricula + Tipo Registro + Digito) |
| matricula_titular | Sim | Caracter | Matricula do Títular do Plano (Operadora + Empresa + Matricula + Tipo Registro + Digito) |
| campos | Sim | Array | Lista de Objetos |
| id | Sim | Caracter | ID do campo na Mobile Saúde |
| label | Sim | Caracter | Label da opção preenchida ou selecionada pelo usuário na Mobile Saúde |
| name | Sim | Caracter | Nome do Campo na Mobile Saúde |
| value | Sim | Caracter | Valor do Campo |
...
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"timestamp": "2022-03-21T17:23:15-03:00",
"data": [],
"status": false,
"critica": [
{
"cod": 0,
"trace": "",
"origem": "/mobileSaude/submit_formulario",
"descricao": " Protocolo informado já existente no sistema. [41750520220318145551]"
}
],
"msg": "Protocolo informado já existente no sistema. [41750520220318145551]"
} |
Estrutura de Retorno
Atributo | Tipo | Descrição |
|---|---|---|
| status | Caracter | Status do Protocolo após a inclusão no sistema. Esse status é corresponde ao da Mobile, ou seja, o sistema já realizou o de/para com o status da BBA_STATUS. |
| mshash | Caracter | HASH que identifica de qual ambiente (Homologação ou Produção), o valor é o mesmo do recebido na API. |
| protocolo | Caracter | Protocolo da Atualização Cadastral. BBA_NROPRO |
| timestamp | Caracter | Data e hora do retorno |
| data | Array | Array sempre vazio |
| critica | Array | Array com as críticas geradas, quando não for possível incluir o protocolo no sistema |
| cod | Numeric | Sempre o valor 0 |
| trace | Caracter | Sempre o vazio |
| origem | Caracter | URL final da API processada |
| descricao | Caracter | Descrição da Crítica gerada pelo sistema |
| msg | Caracter | Mensagem final do erro que não permitiu a inclusão da solicitação. |
Método atualiza_status_protocolo
Este método será utilizado pelo sistema para comunicar com a API da Mobile Saúde para atualizar o status do protocolo solicitado.
Regras de Negocio do Método
Deverá ser cadastrado no campo URL Status (BA0_MSURST), o Endpoint fornecido pelo Mobile Saúde para atualizar o status do protocolo.
Quando o usuário aprovar ou negar a atualização do protocolo na Analise de Beneficiários, o sistema irá realizar a comunicação desse método com a Mobile Saúde.
Também é possível atualizar o status do protocolo através do botão Outras Ações > Atualizar Status da Rotina de Analise de beneficiários.
Endpoint
Url | Método | Header Content-Type | Descrição |
|---|---|---|---|
| Endpoint informado no cadastro da Operadora > Aba Mobile Saúde > Campo URL Status (BA0_MSURST) | POST | application/json | Atualização dos protocolos solicitados pelos beneficiários na base da Mobile Saúde. |
Parâmetros de Entrada do Método
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| id_operadora | Sim | Caracter | ID da Operadora na Mobile Saúde, será enviado o campo BBA_IDOPER |
| mshash | Sim | Caracter | HASH que identifica de qual ambiente (Homologação ou Produção) na Mobile Sáude, será enviado o campo BBA_MSHASH. |
| matricula | Sim | Caracter | Matricula do Beneficiários (Operadora + Empresa + Matricula + Tipo Registro + Digito) no protocolo de Analise de beneficiários. |
| protocolo | Sim | Caracter | Protocolo da Atualização Cadastral, será enviado o campo BBA_NROPRO da Analise de Beneficiários. |
| status | Sim | Caracter | Status do protocolo, será feito o De/para do BBA_STATUS com o status da Mobile Saúde cadastrado na tabela B7V. |
| observacao | Não | Caracter | Observação informada no campo BBA_OBSERV do protocolo. |
Veja um exemplo de como a comunicação com a API é feita na prática:
03. TELA ATUALIZAÇÃO CADASTRAL
...
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
BA0_MSURST | Informe o Endpoint da API de atualização de status do protocolo de alteração cadastral |
| BBA_IDOPER | ID da Operadora na Mobile Saúde |
| BBA_MSHASH | HASH que identifica de qual ambiente (Homologação ou Produção) |
05. TABELAS UTILIZADAS
- BBA - Cabeçalho da Solicitação de Beneficiários
- B7L - Itens das Alterações Solicitadas
- BA0 - Cadastro de Operadoras
- B90 - Layout Genérico Web
- B7C - Grupos de Campos do Layout Genérico Web
- B91 - Campos do Layout Genérico Web
- B2C - Configurações dos Campos do Layout Genérico Web
- BA1 - Cadastro de Beneficiários
- B7V - Cadastro de De/para de Integrações
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas