Versões comparadas

Chave

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


Tópicos:

Índice


URL Base

Endpoint

EndpointMétodoDescriçã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â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.

tipotrue


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_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"
    }
  ]
}


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