Tópicos:
Dica |
---|
|
Exemplo de dica no corpo da página. |
1. Primeiro tópico da Página
Loremipsum |
---|
2 | 2 | 2. Exemplo de bloco de código
Bloco de código |
---|
language | js |
---|
theme | Midnight |
---|
linenumbers | true |
---|
|
PATCH /restapis/restapi_id/documentation/versions/version HTTP/1.1
Host: apigateway.region.amazonaws.com
Content-Type: application/json
X-Amz-Date: YYYYMMDDTttttttZ
Authorization: AWS4-HMAC-SHA256 Credential=access_key_id/YYYYMMDD/region/apigateway/aws4_request, SignedHeaders=content-length;content-type;host;x-amz-date, Signature=sigv4_secret
{
"patchOperations": [{
"op": "replace",
Endpoint | Método | Descrição |
---|
| 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. |
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.
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
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âmetro | Obrigatório | Tipo | Descrição |
---|
protocolo | true |
Cor do plano de fundo |
---|
| String |
|
|
id_operadora | true |
Cor do plano de fundo |
---|
| Inteiro |
| Id da operadora para a qual serão buscados os grupos de menu. |
mshash | true |
Cor do plano de fundo |
---|
| String |
| HASH que identifica de qual ambiente (Homologação ou Produção) os dados serão buscados. |
tipo | false |
Cor do plano de fundo |
---|
| String |
| Tipo de beneficiário a que as informações se referem, conforme seu grau de dependência (t =Titular, d = Dependente, a = Agregado). |
nome | true |
Cor do plano de fundo |
---|
| String |
|
|
matricula | true |
Cor do plano de fundo |
---|
| String |
| Matrícula do usuário que está logado. |
matricula_titular | true |
Cor do plano de fundo |
---|
| String |
| Matrícula do titular da conta. |
campos | true |
Cor do plano de fundo |
---|
| Array |
| Propriedade que enviará os campos do formulário. |
campos.id | true |
Cor do plano de fundo |
---|
| Inteiro |
| ID do tipo de campo que será enviado. |
campos.label | true |
Cor do plano de fundo |
---|
| String |
| Label da opção preenchida ou selecionada pelo usuário. |
campos.name | true |
Cor do plano de fundo |
---|
| String |
| Nome do campo que foi preenchido. |
campos.value | true |
Cor do plano de fundo |
---|
| String |
| Valor do campo preenchido pelo usuário. |
Bloco de código |
---|
language | applescript |
---|
theme | Eclipse |
---|
firstline | 1 |
---|
title | Exemplo de RAW enviado para a url de callback: |
---|
linenumbers | true |
---|
|
{
"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"
},
{
"pathid": "/description49",
"label": "Número",
"value "name": "My API for testing purposes."
atualizacao_cadastral_numero_2",
"value": "android test"
}] } |
2.1. Primeiro tópico da Página
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetur. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.
2.2. Primeiro tópico da Página
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Aliquam fermentum vestibulum est. Cras rhoncus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Sed quis tortor. Donec non ipsum. Mauris condimentum, odio nec porta tristique, ante neque malesuada massa, in dignissim eros velit at tellus. Donec et risus in ligula eleifend consectetur. Donec volutpat eleifend augue. Integer gravida sodales leo. Nunc vehicula neque ac erat. Vivamus non nisl. Fusce ac magna. Suspendisse euismod libero eget mauris.
3. Primeiro tópico da Página
Loremipsum |
---|
2 | 2 | Nota |
---|
|
Adicionando observações no corpo do texto.,
{
"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",
}
]
} |
Dica |
---|
O array de campos varia de acordo com o seu formulário. |
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 |
---|
theme | Eclipse |
---|
firstline | 1 |
---|
title | Retorno de alteração de status |
---|
linenumbers | true |
---|
|
{
"protocolo" : "3139042017080113117" ,
"mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
"status" : "2"
} |