Versões comparadas

Versão antiga 4

changes.mady.by.user Bruno Vieira (Unlicensed)

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

1- ATUALIZAÇÃO CADASTRAL


1.1 - Endpoint:

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

Descrição:

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.

1.2 -

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.


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

.3 - Especificação do callback

.amazonaws.com/AWSAccessKeyId=ABC&Expires=1616095118&Signature=ABCD 

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:


Atributos que podem gerar dúvidas:

ParâmetroObrigatórioTipoDescrição
protocolotrue


Cor do plano de fundo
color#EDEEF1
idtipo
String



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.

tipofalse


Cor do plano de fundo
color#EDEEF1
idtipo
String


Tipo de beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado).
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_titulartrue


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. 


Bloco de código
languageapplescript
themeEclipse
firstline1
titleExemplo de RAW enviado para a url de callback:
linenumberstrue
{
  "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"
    },
	{
	  "id": "859"
      "label": "Comprovante de endere\u00e7o",
      "name": "atualizacao_cadastral_comprovante_de_endereco",
      "value": "https:\/\/atualizacao-cadastral.s3-sa-east-1.amazonaws.com\/969542b3-4ab6-4d54-9261-6196f2eaba5a.1616074616142.png?AWSAccessKeyId=AKIA34OGA4QDSSXFT3F4&Expires=1616076000&Signature=6bH3weEUx5otIY49asdxY%2BN%2Bw0%3D",     
    }
  ]
}


O array de campos varia dinamicamente com o seu formulário
Informações
title
Dica

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.

Bloco de código
themeEclipse
firstline1
titleRetorno de alteração de status
linenumberstrue
{
  "protocolo" : "3139042017080113117" ,
  "mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
  "status" : "2"
}
Informações
titlePara lista de status, consultar o endpoint
/atualizacao_cadastral/api/v1/ws/formulario/get_all_status

 Pesquisa em tempo real