API - listar, detalhar e atualizar protocolos
- Ranniêr Reis
Tópicos:
- 1 1- URL base API
- 2 1.1 - Segurança da informação
- 3 ATENÇÃO
- 4 2- Endpoints
- 5 Atualização Cadastral - endpoint
- 6 2 via de cartão - endpoint
- 7 Reembolso - endpoint
- 8 Cancelamento de plano - endpoint
- 9 Solicitação de autorização - endpoint
- 10 3- Parâmetros
- 11 Atualização Cadastral - parâmetros
- 12 Segunda via de cartão - parâmetros
- 13 Reembolso - parâmetros
- 14 Cancelamento de plano
- 15 Solicitação de autorização - parâmetros
- 16 5- Exemplo de retorno API (Erro)
- 16.1 Retorno API falha
- 17 ATENÇÃO
1- URL base API
Ambientes | URL |
|---|---|
Homologação | |
Produção |
1.1 - Segurança da informação
ATENÇÃO
É importante frizar que a Mobile Saúde está implementando novas políticas de segurança, estamos implementando um novo sistema de Firewall (WAF) para bloqueios que identificarmos como nocivos, onde iremos fortemente atuar em:
Requisições que não sejam consideradas válidas;
Requisições identificadas como instruções de SQL Injection;
Recomendamos fortemente a tratativa de: Mensagens de erro não tratadas (as famosas excepctions), pois o envio de muitas destas requisições ocasionará que o seu serviço de callback seja paralizado.
Nos casos em que identificamos como tentativas nocivas aos serviçõs da Mobile Saúde repetidamente, iremos adotar o BLOQUEIO do ip de origem e com isso os serviços da operadora podem ser paralizados, em casos de falso positivo entre imediatamente em contato com o setor de Atendimento da Mobile Saúde, pelo nosso chat ou telefone para contato.
2- Endpoints
Atualização Cadastral - endpoint
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem status de solicitação atualização cadastral | /atualizacao_cadastral/api/v1/ws/formulario/get_all_status | GET | Retorna os tipos de status de Solicitações de Autorizações. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Detalhes do protocolo de atualização cadastral | /atualizacao_cadastral/api/v1/ws/formulario/get_protocolo | GET | Retorna o status do protocolo requerido. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Atualização status protocolo de atualização cadastral | /atualizacao_cadastral/api/v1/ws/formulario/atualiza_status_protocolo | POST | Atualiza o status de um protocolo de atualização cadastral iniciado. |
2 via de cartão - endpoint
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem status de segunda via de cartão | /solicitacao_cartao/v1/api/status/listar | GET | Lista completa de status de solicitação do cartão |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem de solicitacões de segunda via de cartão | /solicitacao_cartao/v1/api/motivoSolicitacao/listar | GET | Lista de motivos de solicitação de segunda via e cartão cadastradas no painel |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Detalhes de segunda via der cartão | /atualizacao_cadastral/api/v1/ws/formulario/carregar | GET | Detalhes de uma solicitação de cartão |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem formas de entregas segunda via de cartão | /solicitacao_cartao/v1/api/formaEntrega/listar | GET | Lista formas de entrega do cartão cadastrado, ex: buscar no correios, local de trabalho, casa, etc... |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Atualização status protocolo de segunda via de cartão | /solicitacao_cartao/v1/api/solicitacao/atualizarStatus | POST | Atualização dos protocolos solicitados pelos beneficiários na base da Mobile Saúde. |
Reembolso - endpoint
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem status solicitação de reembolso | /plataforma_beneficiario/reembolso_online/v1/api/status/listar | GET | Listagem com os status de Reembolso solicitados. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem tipos de solicitação de reembolso | /plataforma_beneficiario/reembolso_online/v1/api/tipoReembolso/listar | GET | Listagem com os tipos de Reembolso cadastrados. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Detalhes de uma solicitação de reembolso | /plataforma_beneficiario/reembolso_online/v1/api/reembolso/detalhes | GET | Listagem com os detalhes de um pedido de reembolso. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Atualizar protocolo de solicitação de reembolso | /plataforma_beneficiario/reembolso_online/v1/api/reembolso/atualizar | POST | Atualizar pedido de reembolso realizado. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Atualizar usuário atribuído na análise de reembolso | /plataforma_beneficiario/reembolso_online/v1/api/reembolso/atualizar | POST | Atualizar usuário atribuído ao pedido de reembolso realizado. |
Cancelamento de plano - endpoint
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem status cancelamento de plano | /cancelamento_plano/api/v1/ws/formulario/get_all_status | GET | Retorna os tipos de status de cancelamento de plano. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Detalhes de uma solicitação de cancelamento de plano | /cancelamento_plano/api/v1/ws/formulario/get_protocolo | GET | Retorna os detalhes do protocolo requerido. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Atualizar protocolo de solicitação de cancelamento de plano | /cancelamento_plano/api/v1/ws/formulario/atualiza_status_protocolo | POST | Atualiza o status de um protocolo de cancelamento de plano solicitado. |
Solicitação de autorização - endpoint
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Listagem status solicitação de autorização | /solicitacao_autorizacoes/api/v1/ws/formulario/get_all_status | GET | Retorna os tipos de status de Solicitações de Autorizações. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Detalhes de uma solicitação de autorização | /solicitacao_autorizacoes/api/v1/ws/formulario/get_protocolo | GET | Retorna os detalhes de uma solicitação de autorização. |
Feature | Endpoint | Método | Descrição |
|---|---|---|---|
Atualizar protocolo de solicitação de autorização | /solicitacao_autorizacao/api/v1/ws/formulario/atualiza_status_protocolo | POST | Atualiza protocolo de solicitação de autorização. |
3- Parâmetros
Atualização Cadastral - parâmetros
Listagem status de atualização cadastral
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem status de atualização cadastral | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem status de autalização cadastral | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Detalhes protocolo de atualização cadastral
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Detalhes protocolo de atualização cadastral | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Detalhes protocolo de atualização cadastral | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Detalhes protocolo de atualização cadastral | id_protocolo | true | Inteiro | ID do protocolo requerido. |
Atualização protocolo atualização cadastral
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Atualização protocolo atualização cadastral | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Atualização protocolo atualização cadastral | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Atualização protocolo atualização cadastral |
| true | String | Matrícula do beneficiário |
Atualização protocolo atualização cadastral |
| true | String | Protocolo da Solicitação Cadastral. |
Atualização protocolo atualização cadastral | status | true | Inteiro | Status requerido. |
Atualização protocolo atualização cadastral |
| false | String | Algumas observações feitas pelo usuário. |
Segunda via de cartão - parâmetros
Listagem status de segunda via de cartão
Feature | Parâmetros | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem status de segunda via de cartão | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem status de segunda via de cartão | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Listagem solicitação segunda via de cartão
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem solicitação segunda via de cartão | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem solicitação segunda via de cartão | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Listagem forma de entrega segunda via de cartão
Feature | Parâmetros | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem forma de entrega segunda via de cartão | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem forma de entrega segunda via de cartão | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Atualizar protocolo segunda via de cartão
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Atualizar protocolo segunda via de cartão | id_solicitacao_cartao | true | Inteiro | Id da solicitação de segunda via do cartão. |
Atualizar protocolo segunda via de cartão | id_status_cartao | true | Inteiro | Id do status atual da solicitação de segunda via do cartão. |
Atualizar protocolo segunda via de cartão | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Reembolso - parâmetros
Listagem status de reembolso
Feature | Parametro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem status de reembolso | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem status de reembolso | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Listagem tipo de reembolso
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem tipo de reembolso | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem tipo de reembolso | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Listagem destalhes do reembolso
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem destalhes do reembolso | id_operadora | true | Inteiro | ID da operadora para a qual serão buscados os grupos de menu |
Listagem destalhes do reembolso | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Listagem destalhes do reembolso | id_reembolso | true | Inteiro | ID do reembolso que deseja buscar os detalhes. |
Atualizar protocolo de reembolso
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Atualizar protocolo de reembolso | protocolo | true | Inteiro | |
Atualizar protocolo de reembolso | id_reembolso | true | Inteiro | |
Atualizar protocolo de reembolso | id_status_reembolso | true | Inteiro | |
Atualizar protocolo de reembolso | observacao | false | String | |
Atualizar protocolo de reembolso | despesas[0][id_status_reembolso] | true | Inteiro | |
Atualizar protocolo de reembolso | despesas[0][valor_reembolsado] | true | Float | |
Atualizar protocolo de reembolso | despesas[0][valor_coparticipacao] | true | Float | |
Atualizar protocolo de reembolso | despesas[0][valor_uso_indevido] | true | Float | |
Atualizar protocolo de reembolso | despesas[0][valor_glosado] | true | Float | |
Atualizar protocolo de reembolso | despesas[0][id_despesa_reembolso] | true | Inteiro | |
Atualizar protocolo de reembolso | data_pagamento | true | String | |
Atualizar protocolo de reembolso | numero_lote | true | Inteiro | |
Atualizar protocolo de reembolso | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Atualizar protocolo de reembolso | despesas[1][id_despesa_reembolso] | true | Inteiro | |
Atualizar protocolo de reembolso | despesas[1][valor_glosado] | true | Inteiro | |
Atualizar protocolo de reembolso | despesas[1][id_status_reembolso] | true | Inteiro |
Atualizar usuário atribuído na análise de reembolso
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Atualizar usuário atribuído na análise de reembolso | id_reembolso | true | Inteiro | Id do reembolso para a qual será atualizado. |
Atualizar usuário atribuído na análise de reembolso | id_ms_usuario | true | Inteiro | |
Atualizar usuário atribuído na análise de reembolso | mshash | false | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Cancelamento de plano
Listagem status cancelamento de plano
Feature | Parâmetros | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem status cancelamento de plano | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem status cancelamento de plano | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Detalhes de uma solicitação de cancelamento de plano
Feature | Parâmetros | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Detalhes de uma solicitação de cancelamento de plano | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Detalhes de uma solicitação de cancelamento de plano | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Detalhes de uma solicitação de cancelamento de plano | id_protocolo | true | Inteiro | ID do protocolo requerido. |
Atualizar uma solicitação de cancelamento de plano
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Atualizar uma solicitação de cancelamento de plano | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Atualizar uma solicitação de cancelamento de plano | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Atualizar uma solicitação de cancelamento de plano |
| true | String | Matrícula do beneficiário |
Atualizar uma solicitação de cancelamento de plano |
| true | String | Protocolo da Solicitação Cadastral. |
Atualizar uma solicitação de cancelamento de plano | status | true | Inteiro | Status requerido. |
Atualizar uma solicitação de cancelamento de plano |
| false | String | Algumas observações feitas pelo usuário. |
Solicitação de autorização - parâmetros
Listagem solicitação de autorização
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Listagem solicitação de autorização | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Listagem solicitação de autorização | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Detalhes de uma solicitação de autorização
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Detalhes de uma solicitação de autorização | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Detalhes de uma solicitação de autorização | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Detalhes de uma solicitação de autorização | id_protocolo | true | Inteiro | ID do protocolo requerido. |
Atualização de uma solicitação de autorização
Feature | Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|---|
Atualização de uma solicitação de autorização | id_operadora | true | Inteiro | Id da operadora para a qual serão buscados os grupos de menu |
Atualização de uma solicitação de autorização | mshash | true | String | HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
Atualização de uma solicitação de autorização |
| true | String | Matrícula do beneficiário |
Atualização de uma solicitação de autorização |
| true | String | Protocolo da Solicitação Cadastral. |
Atualização de uma solicitação de autorização | status | true | Inteiro | Status requerido. |
Atualização de uma solicitação de autorização |
| false | String | Algumas observações feitas pelo usuário. |
4- Exemplo de retorno API (Sucesso)
Retorno API sucesso
{
"status": true,
"data": [],
"critica": [],
"timestamp": "2017-08-02T10:52:13-03:00",
"msg":"Sucesso"
}5- Exemplo de retorno API (Erro)
Retorno API falha
"status": false,
"data": [],
"critica": [
{
"cod": 0,
"descricao": "O status é inválido",
"origem": "/mssuite/solicitacao_autorizacao/api/v1/ws/formulario/atualiza_status_protocolo/",
"trace": ""
}
],
"timestamp": "2019-04-22T11:12:51-03:00",
"msg": "O status é inválido"
}ATENÇÃO
É importante frizar que a Mobile Saúde está implementando novas políticas de segurança, estamos implementando um novo sistema de Firewall (WAF) para bloqueios que identificarmos como nocivos, onde iremos fortemente atuar em:
Requisições que não sejam consideradas válidas;
Requisições identificadas como instruções de SQL Injection;
Recomendamos fortemente a tratativa de: Mensagens de erro não tratadas (as famosas excepctions), pois o envio de muitas destas requisições ocasionará que o seu serviço de callback seja paralizado.
Nos casos em que identificamos como tentativas nocivas aos serviçõs da Mobile Saúde repetidamente, iremos adotar o BLOQUEIO do ip de origem e com isso os serviços da operadora podem ser paralizados, em casos de falso positivo entre imediatamente em contato com o setor de Atendimento da Mobile Saúde, pelo nosso chat ou telefone para contato.
Mobile Saúde - 2019