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": [{
1- ATUALIZAÇÃO CADASTRAL
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:
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",
"opvalue": "replace"1212121"
},
{
"pathid": "/description49",
"label": "Número",
"valuename": "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. |
Informações |
---|
title | O array de campos varia dinamicamente com o seu formulário |
---|
|
O array de campos varia dinamicamente 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 |
---|
theme | Eclipse |
---|
firstline | 1 |
---|
title | Retorno de alteração de status |
---|
linenumbers | true |
---|
|
{
"protocolo" : "3139042017080113117" ,
"mshash" : "NjA1ZDhkNjkzN2RjMzE3NTg2ZjUyMzgyZTk5ZTkyMGU4MDA2ZGFiNg==" ,
"status" : "2"
} |
Comentário HTML |
---|
Para lista de status, consultar o endpoint /atualizacao_cadastral/api/v1/ws/formulario/get_all_status |