Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

Versão 1 Próxima »

Tópicos:

1- URL base API

AmbientesURL
Homologaçãohttps://ms3.tapcore.com.br/mssuite/
Produçãohttps://ms3.tapcore.com.br/mssuite/


2- Endpoints


Atualização Cadastral 

FeatureEndpointMétodoDescriçã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.

FeatureEndpointMétodoDescrição

Detalhes do protocolo de atualização cadastral

/atualizacao_cadastral/api/v1/ws/formulario/get_protocolo

GET

Retorna o status do protocolo requerido.

FeatureEndpointMétodoDescriçã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

FeatureEndpointMétodoDescriçã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

FeatureEndpointMétodoDescriçã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

FeatureEndpointMétodoDescrição

Detalhes de segunda via der cartão

/atualizacao_cadastral/api/v1/ws/formulario/carregarGETDetalhes de uma solicitação de cartão
FeatureEndpointMétodoDescrição

Listagem formas de entregas segunda via de cartão

/solicitacao_cartao/v1/api/formaEntrega/listarGETLista formas de entrega do cartão cadastrado, ex: buscar no correios, local de trabalho, casa, etc...
FeatureEndpointMétodoDescrição

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

/solicitacao_cartao/v1/api/solicitacao/atualizarStatusPOSTAtualização dos protocolos solicitados pelos beneficiários na base da Mobile Saúde.


3- Parâmetros query string

ParâmetroObrigatórioTipoDescrição
id_operadoratrue
Inteiro

Id da operadora para a qual serão buscados os grupos de menu

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)

Retorno API sucesso 
[
    {
        "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
    },
    {
        "id_cms_menu_site_grupo": 36,
        "nome": "Menu Topo Botões",
        "chave": "menu-topo-botoes",
        "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": 2
    }
]

5- Exemplo de retorno API (Erro)

Retorno API falha 
{
    "error": "Erro: Cliente não encontrado.",
    "code": 0,
    "status": false
}



ATENÇÃO

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


  • Sem rótulos

Mobile Saúde - 2019