Comparação de Páginas

Tópicos:

Índice

URL Base

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

Endpoint

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

Como configurar a URL de callback

Acesse o seu painel administrativo em: painel.tapcore.com.br, no menu lateral busque a funcionalidade: Beneficiário > Cancelamento de plano> 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 cancelamento de plano.

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

Especificação do Callback do Cancelamento de plano

Uma particularidade do formulário de cancelamento de plano é que ele é dinamicamente configurável, por esse motivo os dados enviados que serão documentados abaixo poderão variar de acordo com o estado atual do seu formulário, mas o padrão se matem.

O callback será feito através de uma requisição HTTP do tipo POST ao serviço cadastrado, os parâmetros serão enviados via RAW no formato JSON, conforme as especificações abaixo:

Atributos que podem gerar dúvidas

Parâmetro

Obrigatório

Tipo

Descrição

protocoloid_motivo_solic_cancelamento

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

Conforme cadastro dos motivos de cancelamento, configurados pelo cliente no painel de administração (CMS).

id_operadora

true

Cor do plano de fundo

color	#EDEEF1

Inteiro

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

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.

tipoid_status_cancelamento

false

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

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

nome

true

Cor do plano de fundo

color	#EDEEF1
id	tipo

String

matriculatrue
Cor do plano de fundo
color #EDEEF1
id tipo
String
Matrícula do usuário que está logado.matricula_titulartrue
Cor do plano de fundo
color #EDEEF1
id tipo
String
Matrícula do titular da conta.campostrue
Cor do plano de fundo
color #EDEEF1
id tipo
Array
Propriedade que enviará os campos do formulário.campos.idtrue
Cor do plano de fundo
color #EDEEF1
id tipo
Inteiro
ID do tipo de campo que será enviado.campos.labeltrue
Cor do plano de fundo
color #EDEEF1
id tipo
String
Label da opção preenchida ou selecionada pelo usuário.campos.nametrue
Cor do plano de fundo
color #EDEEF1
id tipo
String
Nome do campo que foi preenchido.campos.valuetrue
Cor do plano de fundo
color #EDEEF1
id tipo
String
Valor do campo preenchido pelo usuário.
Status do cancelamento, conforme regra:
1 - Solicitado;
2 - Em processamento;
3 - Concluído

Bloco de código

language	applescript
theme	Eclipse
firstline	1
title	Exemplo de RAW enviado para a url de callback:
linenumbers	true

{
   "id_solicitacao_cancelamento":"48",
   "id_protocolo":" XYZ1228",
   "id_operadora":"16",
   "id_motivo_solic_cancelamento": 9999"3",
   "id_status_cancelamento":"1",
  "mshash" : ""  "matricula_titular":"00010061003247003",
   "nome_titular":"NOME DO BENEFICIARIO DE EXEMPLO",
  "tipo" : "" , "cpf_titular":"94243280010",
   "telefone_titular":"02733410188",
   "email_titular":"teste@emaildobeneficiario.com.br",
   "nomepatrocinadora_titular" : "Nome 1",
,   "descricao":"matricula",
 :  "texto_complementar":"LOREM IPSUM",
   "matriculadata_titular" : "999solicitacao":"2020-11-14 09:28:30",
   "protocolo":"20171114500003",
   "camposmshash" :"ZDhkNjY0MDY3NTgwMTg0Y2I4ZWE3ZmZiZGEyNDM0NmMwZDI0YmQwYw==",
   "beneficiarios":[
      {
         "idnome": "10"NOME DO BENEFICIARIO DE EXEMPLO",
         "labelmatricula": "País90909090909090909",
         "nameparentesco":"Titular",
         "atualizacao_cadastral_pais",data_nascimento":"1978-08-01",
         "valueconvenio_segmentacao":"AMBULATORIAL + HOSPITALAR COM OBSTETRICIA "android test"+ ODONTOLOGICO",
         }"numero_contrato":"00010061000000000002001000000011001",
    {     "texto_complementar":null,
		 "iddata_inclusao":"2020-04-01",
		 "5","convenio_ans":"1001"
      },
      {
         "labelnome": "Telefone residencial","NOME DO BENEFICIARIO DEPENDENTE DE EXEMPLO",
         "namematricula": "atualizacao_cadastral_telefone_residencial"90909090909090909222",
         "valueparentesco": "1212121Dependente",
    },
      "data_nascimento":"1978-08-01",
  {       "idconvenio_segmentacao": "49","AMBULATORIAL + HOSPITALAR COM OBSTETRICIA + ODONTOLOGICO",
         "labelnumero_contrato": "Número00010061000000000002001000000011001",
      "name   "texto_complementar":null,
		 "atualizacao_cadastral_numero_2",
data_inclusao":"2020-04-01",
		 "convenio_ans":"1001"
      }
   ],
   "valuestatus": "android testSolicitado",
    }
  ]
}

Dica

O array de campos varia de acordo com o seu formulário.

"motivo":"Reajuste no valor do plano"
}

2- Retornos de sucesso Callback Cancelamento de plano

Todo callback executado, que tenha como retorno status header 200 será considerado uma conexão de sucesso, independente do seu retorno.
É possível também alterar o status da solicitação de cancelamento de plano, basta que o serviço de integração retorne em seu body um JSON no padrão abaixo.

Bloco de código

theme	Eclipse
firstline	1
title	Retorno de alteração de status
linenumbers	true

{
  "protocolo" : "3139042017080113117" ,
  "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
  "status" : "2"
}

Pesquisa em tempo real

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

URL Base

Endpoint

formulario/submit_formulario

Como configurar a URL de callback

Segurança das URLs

Especificação do Callback do Cancelamento de plano

Atributos que podem gerar dúvidas

2- Retornos de sucesso Callback Cancelamento de plano