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 | ||
|---|---|---|
| ||
|
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 | |||||||
|---|---|---|---|---|---|---|---|---|---|---|
| protocolo | true |
| ||||||||
| id_operadora | true |
| Id da operadora para a qual serão buscados os grupos de menu. | |||||||
mshash | true |
| HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. | |||||||
| tipo | truefalse |
| Tipo de formulário a ser enviadode beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado). | |||||||
| nome | true |
| ||||||||
| matricula | true |
| Matrícula do usuário que está logado. | |||||||
| matricula_titular | true |
| Matrícula do titular da conta. | |||||||
| campos | true |
| Propriedade que enviará os campos do formulário. | |||||||
| campos.id | true |
| ID do tipo de campo que será enviado. | |||||||
| campos.label | true |
| Label da opção preenchida ou selecionada pelo usuário. | |||||||
| campos.name | true |
| Nome do campo que foi preenchido. | |||||||
| campos.value | true |
| Valor do campo preenchido pelo usuário. |
| Bloco de código | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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"
}
]
} |
| Dica |
|---|
O array de campos varia de acordo com o seu formulário. |
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 | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
{
"protocolo" : "3139042017080113117" ,
"mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
"status" : "2"
} |
| Pesquisa em tempo real |
|---|