Versões comparadas

Versão antiga 1

changes.mady.by.user Ranniêr Reis

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Ranniêr Reis

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


Tópicos:

Índice


URL Base

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

Endpoint

EndpointMétodoDescrição

formulario/submit_formulario

PUT

Responsável por inserir uma nova solicitação de cancelamento de atualização cadastral 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 > Atualização Cadastral> 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 atualização cadastral.

Especificação do Callback da Atualização Cadastral

de cancelamento de plano.


Segurança das URLs


Informações
titleImportante

(aviso)    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 atualização cadastral 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:

Parâmetros


Atributos que podem gerar dúvidas

ParâmetroObrigatórioTipoDescrição
protocoloid_motivo_solic_cancelamentotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String


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


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
idtipo
String


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

tipo

true
Cor do plano de fundo
color#EDEEF1
idtipo
String
Tipo de formulário a ser enviado.nometrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
matriculatrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
Matrícula do usuário que está logado.matricula_titulartrueid_status_cancelamentofalse


Cor do plano de fundo
color#EDEEF1
idtipo
String
Matrícula do titular da conta.campostrue
Cor do plano de fundo
color#EDEEF1
idtipo
Array
Propriedade que enviará os campos do formulário.campos.idtrue
Cor do plano de fundo
color#EDEEF1
idtipo
Inteiro
ID do tipo de campo que será enviado.campos.labeltrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
Label da opção preenchida ou selecionada pelo usuário.


campos.nametrue
Cor do plano de fundo
color#EDEEF1
idtipo
String
Nome do campo que foi preenchido.campos.valuetrue
Cor do plano de fundo
color#EDEEF1
idtipo
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
languageapplescript
themeEclipse
firstline1
titleExemplo de RAW enviado para a url de callback:
linenumberstrue
{
   "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",
,   "matriculadescricao":"",
: ""    "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 "android test"COM OBSTETRICIA + ODONTOLOGICO",
         }"numero_contrato":"00010061000000000002001000000011001",
    {     "texto_complementar":null,
		 "iddata_inclusao": "5","2020-04-01",
		 "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":"AMBULATORIAL + HOSPITALAR COM OBSTETRICIA + ODONTOLOGICO"49",
         "labelnumero_contrato": "Número00010061000000000002001000000011001",
         "nametexto_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

Atualização Cadastral

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 atualização cadastralplano, basta que o serviço de integração retorne em seu body um JSON no padrão abaixo.

Bloco de código
themeEclipse
firstline1
titleRetorno de alteração de status
linenumberstrue
{
  "protocolo" : "3139042017080113117" ,
  "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
  "status" : "2"
}


Pesquisa em tempo real