Comparação de Páginas

Tópicos:

Índice

1- URL base API

Ambientes	URL
Homologação	https://ms3.tapcore.com.br/mssuite/
Produção	https://ms3.tapcore.com.br/mssuite/

1.1 - Segurança da informação

Nota

title	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

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

3- Parâmetros query string

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

#EDEEF1

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
Cor do plano de fundo
color		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

Cor do plano de fundocolor#EDEEF1idtipo

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

.

4- Exemplo de retorno API (Sucesso) Bloco de código

language	js
theme	Midnight
title	Retorno API sucesso
linenumbers	true
collapse	true

[ { "id_cms_menu_site_grupo": 34, "nome": "Área do Beneficiário", "chave": "area-do-beneficiario", "base_url_producao": "http://localhost:8080/#/", "base_url_homologacao": "http://localhost:8080/#/", "base_url_dev": "http://localhost:8080/#/", "id_operadora": 165, "id_aplicacao": 7, "qtd_niveis": 1 }, { "id_cms_menu_site_grupo": 35, "nome": "Área do Conveniado", "chave": "area-do-conveniado", "base_url_producao": "http://localhost:8080/#/", "base_url_homologacao": "http://localhost:8080/#/", "base_url_dev": "http://localhost:8080/#/", "id_operadora": 165, "id_aplicacao": 7, "qtd_niveis": 1 }, { "id_cms_menu_site_grupo": 33, "nome": "Menu do Rodapé", "chave": "menu-do-rodape", "base_url_producao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/", "base_url_homologacao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/", "base_url_dev": "http://localhost:8080/#/", "id_operadora": 165, "id_aplicacao": 7, "qtd_niveis": 2 }, { "id_cms_menu_site_grupo": 31, "nome": "Menu do Topo", "chave": "menu-do-topo", "base_url_producao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/", "base_url_homologacao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/", "base_url_dev": "http://localhost:8080/#/", "id_operadora": 165, "id_aplicacao": 7, "qtd_niveis": 3 }, {

.
Atualização protocolo atualização cadastral	`matricula`	true	String	Matrícula do beneficiário
Atualização protocolo atualização cadastral	`protocolo`	true	String	Protocolo da Solicitação Cadastral.
Atualização protocolo atualização cadastral	status	true	Inteiro	Status requerido.
Atualização protocolo atualização cadastral	`observacao`	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	`matricula`	true	String	Matrícula do beneficiário
Atualizar uma solicitação de cancelamento de plano	`protocolo`	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	`observacao`	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	`matricula`	true	String	Matrícula do beneficiário
Atualização de uma solicitação de autorização	`protocolo`	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	`observacao`	false	String	Algumas observações feitas pelo usuário.

4- Exemplo de retorno API (Sucesso)

Bloco de código

language	js
theme	Midnight
firstline	1
title	Retorno API sucesso
linenumbers	true

{
    "status": true,
    "data": [],
    "critica": [],
    "timestamp": "2017-08-02T10:52:13-03:00",
    "msg":"Sucesso"
}

5- Exemplo de retorno API (Erro)

Bloco de código

language	js
theme	Midnight
firstline	1
title	Retorno API falha
linenumbers	true

    "status": false,
    "data": [],
    "critica": [
        {
            "id_cms_menu_site_grupocod": 360,
        "nome": "Menu Topo Botões",
        "chavedescricao": "menu-topo-botoes",
  O status é inválido",
     "base_url_producao": "http://localhost:8080/#/",
        "base_url_homologacaoorigem": "http://localhost:8080/#/",
        "base_url_dev": "http://localhost:8080/#mssuite/solicitacao_autorizacao/api/v1/ws/formulario/atualiza_status_protocolo/",
        "id_operadora": 165,
        "id_aplicacaotrace": 7,""
        "qtd_niveis": 2
}
   }
]

5- Exemplo de retorno API (Erro)

Bloco de código

language	js
theme	Midnight
title	Retorno API falha
linenumbers	true
collapse	true

{ ],
    "errortimestamp": "Erro: Cliente não encontrado.2019-04-22T11:12:51-03:00",
    "codemsg": 0,"O status é   "statusinválido":
false
}

Esse endpoint não possui retorno de erro mesmo enviando dados inválidos ele retorna como se não tivesse registro.Padrões documentação API

Nota

title	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.

Comparação de Páginas

Versões comparadas

Versão antiga 1

Nova versão Atual

Chave

Índice

1- URL base API

1.1 - Segurança da informação

2- Endpoints

Atualização

Cadastral - endpoint

Listagem status de solicitação atualização cadastral

Detalhes do protocolo de atualização cadastral

Atualização status protocolo de atualização cadastral

2 via de cartão - endpoint

Listagem status de segunda via de cartão

Listagem de solicitacões de segunda via de cartão

Detalhes de segunda via der cartão

Listagem formas de entregas segunda via de cartão

Atualização status protocolo de segunda via de cartão

Reembolso - endpoint

Listagem status solicitação de reembolso

Listagem tipos de solicitação de reembolso

Detalhes de uma solicitação de reembolso

Atualizar protocolo de solicitação de reembolso

Atualizar usuário atribuído na análise de reembolso

Cancelamento de plano - endpoint

Listagem status cancelamento de plano

Detalhes de uma solicitação de cancelamento de plano

Atualizar protocolo de solicitação de cancelamento de plano

Solicitação de autorização - endpoint

Listagem status solicitação de autorização

Detalhes de uma solicitação de autorização

Atualizar protocolo de solicitação de autorização

3- Parâmetros

Atualização Cadastral - parâmetros

Listagem status de atualização cadastral

Detalhes protocolo de atualização cadastral

Atualização protocolo atualização cadastral

Segunda via de cartão - parâmetros

Listagem status de segunda via de cartão

Listagem solicitação segunda via de cartão

Listagem forma de entrega segunda via de cartão

Atualizar protocolo segunda via de cartão

Reembolso - parâmetros

Listagem status de reembolso

Listagem tipo de reembolso

Listagem destalhes do reembolso

Atualizar protocolo de reembolso

Atualizar usuário atribuído na análise de reembolso

Cancelamento de plano

Listagem status cancelamento de plano

Detalhes de uma solicitação de cancelamento de plano

Atualizar uma solicitação de cancelamento de plano

Solicitação de autorização - parâmetros

Listagem solicitação de autorização

Detalhes de uma solicitação de autorização

Atualização de uma solicitação de autorização

5- Exemplo de retorno API (Erro)

5- Exemplo de retorno API (Erro)