Appearance
Fluxo de Integração (Passo a Passo)
Orientações para os atores clientes que desejam realizar a primeira conexão
1. Obter Token
- Consulte o Apêndice 1 do manual e gere o token.
- Armazenamento seguro: cache criptografado, memória volátil ou outro local temporário protegido.
- Nunca exponha o token em logs ou código‑fonte público.
2️. Validar Dados (local)
- Respeitar o tamanho máximo de strings e o formato dos demais campos.
- Formato de datas:
YYYY‑MM‑DD. - Atentar para as regras condicionais do campo
tipoImovel. - Somatório de
percTitularidade= 100 % (quando houver mais de um titular).
3️. Montar Payload
- Construa o JSON ou NDJSON exatamente como descrito na especificação.
- Use bibliotecas de serialização (ex.:
Jackson,System.Text.Json,Gson). - Garanta a precisão de casas decimais e a ordem dos campos quando necessário.
4️. Chamar API
- Envie POST com headers configurados a depender da especificação do serviço, como exemplo abaixo.
http
Authorization: Bearer <seu_token>
Content-Type: application/json # ou application/ndjsonTratar Resposta –
201 → Município tratar os dados retornados para enriquecimento do seu cadastro de origem.
4xx/5xx → Logar o corpo de erro, aplicar retry (máx. 3 tentativas) apenas para 5xx ou timeout.
5. Auditoria (Sugestões)
Salvar em log: timestamp, payload enviado (sem dados sensíveis como CPF completo), código de resposta e id da UI.
6. Monitoramento (Sugestões)
Configurar alertas no APM para taxa de erro > 2 % ou latência > 2 s.