Documentação da API HAU

Bem-vindo à nossa documentação. Encontre guias, exemplos e tudo que você precisa para integrar o poder da HAU em suas aplicações.

Primeiros Passos

Um guia rápido para fazer sua primeira chamada, obter sua chave e começar a explorar nossos recursos.

Explorar Seção

Autenticação

Aprenda como autenticar suas requisições de forma segura utilizando chaves de API.

Explorar Seção

Primeiros Passos

Integrar com a API HAU é um processo simples. Siga estes passos para fazer sua primeira requisição e receber insights preditivos em minutos.

1. Obtenha sua Chave de API

Após se inscrever em um de nossos planos, você receberá uma chave de API exclusiva no seu painel de controle. Esta chave é o seu identificador único e deve ser mantida em segredo.

2. Faça sua Primeira Requisição

Vamos usar o endpoint de avaliação como exemplo. Você pode usar `cURL` ou qualquer cliente HTTP para fazer a chamada. Lembre-se de substituir `SUA_CHAVE_DE_API` pela sua chave real.

curl -X POST 'https://api.hau.com/v1/predict/valuation' \
-H 'Authorization: Bearer SUA_CHAVE_DE_API' \
-H 'Content-Type: application/json' \
-d '{
  "latitude": -23.55052,
  "longitude": -46.633308,
  "area_m2": 120,
  "bedrooms": 3
}'

3. Explore a Referência Completa

Agora que você fez sua primeira chamada, explore nossa referência completa para descobrir todos os endpoints e possibilidades que a API oferece.

Ir para a Referência da API

Autenticação

Todas as requisições à API HAU devem ser autenticadas. Usamos o esquema de autenticação `Bearer Token`, que é simples e seguro.

Você deve incluir um cabeçalho `Authorization` em todas as suas requisições, com o valor `Bearer ` seguido da sua chave de API.

Authorization: Bearer SUA_CHAVE_DE_API

Importante:

Mantenha sua chave de API segura e não a exponha em código do lado do cliente (frontend). Todas as chamadas para a API devem ser feitas a partir do seu backend.

Conceitos Principais

Modelos Preditivos e Confidence Score

Nossos modelos analisam centenas de variáveis para prever valorização e riscos. Cada previsão vem acompanhada de um `confidence_score` (0 a 1), que representa nossa confiança na predição. Scores acima de 0.85 indicam altíssima confiabilidade, baseada em uma grande densidade de dados para a área consultada.

Correlações Invisíveis

A HAU descobre relações entre dados não-óbvios (como o aumento de buscas por 'escolas Montessori') e a valorização imobiliária. O endpoint `/data/correlations` permite que você acesse essa base de conhecimento única para enriquecer suas próprias análises de mercado e identificar oportunidades pioneiras.

Scores de Risco (LegalIQ)

Para cada análise de Due Diligence, a HAU calcula um `legal_risk_score` (0 a 10). Scores mais altos indicam maior risco. Este score é uma agregação de dezenas de fatores, como pendências judiciais, restrições ambientais e problemas na matrícula. A API detalha cada um dos problemas encontrados para uma análise completa.