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 - Como configurar a URL de Callback

Acesse o seu painel administrativo em: painel.tapcore.com.br e no menu lateral busque a funcionalidade:

Beneficiário -> Nome da Feature -> Configuração

Preencha o campo: URL de Callback com a URL que receberá a requisição de callback após inserção de uma nova solicitação de cartão.

2 - Segurança das URLs

Informações

title	IMPORTANTE

Todas as imagens que estão sob nosso domínio não são disponibilizadas de forma pública, favor seguir as recomendações abaixo!

Por questões de segurança todas as imagens ou objetos disponíveis através de uma URL serão enviadas com uma assinatura, desta forma, o download dos objetos ou imagens disponíveis, só serão possíveis por um período de aproximadamente 15 minutos.

Recomenda-se que seja feito o download da imagem ou objeto assinado assim que receber este payload e não salve a URL pois ela ficará indisponível após o tempo pré-determinado.

Em casos que seja necessário o acesso a este objeto ou imagem depois desse período, re-envie o callback através do painel para receber uma nova assinatura válida por mais 15 minutos

Exemplo da url ->https://autorizacao.s3-sa-east-1.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD

3 - Endpoints

Nota

title	ATENÇÃO

Utilize abaixo apenas o endpoint do serviço contratado, todos os serviços necessitam de auxilio/implementação da Mobile Saúde.

Feature	Endpoint	Método	Descrição
Atualização Cadastral	formulario/submit_formulario	PUT	Responsável por inserir uma nova solicitação de atualização cadastral para análise, o beneficiário envia seus dados pessoais, correções e alterações de seu cadastro e arquivos de comprovante.

Feature	Endpoint	Método	Descrição
2 via de Cartão	solicitacao/solicitacao_cartao	PUT	Responsável por inserir uma nova solicitação de segunda via de cartão para análise, o beneficiário informa

os beneficiários que desejam novos cartões

que deseja um novo cartão, motivo e forma de entrega, por fim os

administradores

atendentes/colaboradores autorizam ou não a segunda via.

Feature	Endpoint	Método
Reembolso	reembolso/inserir	POST
Endpoint	Método	Descrição
v4/post_grupo	PATCH	Descrição do método PATCH.
Endpoint	Método	Descrição
v4/post_grupo	DELETE	Descrição do método DELETE.

3- Parâmetros query string

Descrição

Parâmetro	Obrigatório	Tipo	Responsável por inserir uma nova solicitação de reembolso para análise, o beneficiário informa um novo reembolso que por fim os atendentes/colaborador autorizam o reembolso ou não.

4- Parâmetros

Atualização Cadastral

#EDEEF1

Feature

Parâmetro

Obrigatório

Tipo

Descrição

Atualização Cadastral

protocolo

true

String

Atualização Cadastral

id_operadora

true

Cor do plano de fundo

color

Inteiro

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

Atualização Cadastral

mshash

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados.

Atualização Cadastral

tipo

false

String

Tipo de beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado).

Atualização Cadastral

nome

true

String

Atualização Cadastral

matricula

true

String

Matrícula do usuário que está logado.

Atualização Cadastral

matricula_titular

true

String

Matrícula do titular da conta.

Atualização Cadastral

campos

true

Array

Propriedade que enviará os campos do formulário.

Atualização Cadastral

campos.id

true

Inteiro

ID do tipo de campo que será enviado.

Atualização Cadastral

campos.label

true

String

Label da opção preenchida ou selecionada pelo usuário.

Atualização Cadastral

campos.name

true

String

Nome do campo que foi preenchido.

Atualização Cadastral

campos.value

true

String

Valor do campo preenchido pelo usuário.

4

5- Exemplo de retorno API (Sucesso)

Atualização Cadastral

Bloco de código

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

[
    {
     "protocolo":" XYZ",
  "id_cms_menu_site_grupo"operadora" : 349999,
   
    "nomemshash" : "Área do" Beneficiário",
   
    "chavetipo" : "area-do-beneficiario" ,
        "base_url_producao": "http://localhost:8080/#/",
     "nome" : "Nome 1" ,
  "base_url_homologacaomatricula" : "http://localhost:8080/#/",
  " ,
     "basematricula_url_devtitular": "http://localhost:8080/#/",
        "id_operadora": 165,
     999",
  "id_aplicacao": 7,
        "qtd_niveis": 1
    },campos" :
  [
     {
 
      "id_cms_menu_site_grupo": 35,
        "nome": "Área do Conveniado10",

       "chavelabel": "area-do-conveniadoPaís",

       "base_url_producaoname": "http://localhost:8080/#/",
        "base_url_homologacao": "http://localhost:8080/#/",
atualizacao_cadastral_pais",
       "base_url_devvalue": "http://localhost:8080/#/",
        "id_operadora": 165,
        "id_aplicacao": 7,
        "qtd_niveis": 1android test"
     },
    {
 
      "id_cms_menu_site_grupo": 33,
        "nome": "Menu do Rodapé"5",
        "chavelabel": "menu-do-rodape",
        "base_url_producao": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/",
 Telefone residencial",
      "base_url_homologacaoname": "http://homologacao.tapcore.com.br/mssuite/site/site-mutua/frontend/",
        "base_url_dev": "http://localhost:8080/#/",
        "id_operadora": 165,
atualizacao_cadastral_telefone_residencial",
       "id_aplicacaovalue": 7,
        "qtd_niveis1212121":
2     },
    {
        "id_cms_menu_site_grupo": 31,
        "nome": "Menu do Topo49",
        "chavelabel": "menu-do-topoNúmero",
        "base_url_producao"name": "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/#/atualizacao_cadastral_numero_2",
        "id_operadoravalue": 165,         "id_aplicacao": 7,
        "qtd_niveis": 3"android test"
     },
    {
 
      "id_cms_menu_site_grupo": 36,
 "859"
      "nomelabel": "MenuComprovante Topode Botõesendere\u00e7o",
        "chavename": "menu-topo-botoes",
        "base_url_producao": "http://localhost:8080/#/",
        "base_url_homologacao": "http://localhost:8080/#/",
 atualizacao_cadastral_comprovante_de_endereco",
      "base_url_devvalue": "httphttps:\//localhost:8080/#/\/atualizacao-cadastral.s3-sa-east-1.amazonaws.com\/969542b3-4ab6-4d54-9261-6196f2eaba5a.1616074616142.png?AWSAccessKeyId=AKIA34OGA4QDSSXFT3F4&Expires=1616076000&Signature=6bH3weEUx5otIY49asdxY%2BN%2Bw0%3D",    
    "id_operadora": 165,}
         "id_aplicacao": 7,
        "qtd_niveis": 2
    }
]

5

]
}

6- Exemplo de retorno API (Erro)

Bloco de código

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

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

Nota

title	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

Versões comparadas

Versão antiga 2

Nova versão 3

Chave

1 - URL base API

1.1 - Como configurar a URL de Callback

2 - Segurança das URLs

3 - Endpoints

Atualização Cadastral

2 via de Cartão

Reembolso

4- Parâmetros

Atualização Cadastral

5- Exemplo de retorno API (Sucesso)

Atualização Cadastral

6- Exemplo de retorno API (Erro)