Ir para o final dos metadados
Ir para o início dos metadados

Você está vendo a versão antiga da página. Ver a versão atual.

Comparar com o atual Ver Histórico da Página

« Anterior Versão 6 Próxima »


Tópicos:

1- ATUALIZAÇÃO CADASTRAL

1.1 - Endpoint: formulario/submit_formulario

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.

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


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

Para lista de status, consultar o endpoint

/atualizacao_cadastral/api/v1/ws/formulario/get_all_status


  • Sem rótulos