Envio de solicitação de Cancelamento de plano

Tópicos:

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

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

Uma particularidade do formulário de atualização cadastral é 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

Parâmetro	Obrigatório	Tipo	Descrição
protocolo	true	String
id_operadora	true	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.
tipo	true	String	Tipo de formulário a ser enviado.
nome	true	String
matricula	true	String	Matrícula do usuário que está logado.
matricula_titular	true	String	Matrícula do titular da conta.
campos	true	Array	Propriedade que enviará os campos do formulário.
campos.id	true	Inteiro	ID do tipo de campo que será enviado.
campos.label	true	String	Label da opção preenchida ou selecionada pelo usuário.
campos.name	true	String	Nome do campo que foi preenchido.
campos.value	true	String	Valor do campo preenchido pelo usuário.

Exemplo de RAW enviado para a url de callback:

{
  "protocolo":" XYZ",
  "id_operadora" : 9999,
  "mshash" : "" ,
  "tipo" : "" ,
  "nome" : "Nome 1" ,
  "matricula" : "" ,
  "matricula_titular" : "999",
  "campos" : 
  [
    {
      "id": "10",
      "label": "País",
      "name": "atualizacao_cadastral_pais",
      "value": "android test"
    },
    {
      "id": "5",
      "label": "Telefone residencial",
      "name": "atualizacao_cadastral_telefone_residencial",
      "value": "1212121"
    },
    {
      "id": "49",
      "label": "Número",
      "name": "atualizacao_cadastral_numero_2",
      "value": "android test"
    }
  ]
}

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

2- Retornos de sucesso Callback Atualização Cadastral

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

Retorno de alteração de status

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