Visão Geral da API REST

A API do CastleR AVM (Automated Valuation Model) disponibiliza acesso programático de alta performance aos motores estatísticos de avaliação imobiliária da plataforma CastleR. A solução utiliza macromodelos em nuvem, regressão estatística avançada e krigagem espacial para determinação de valores de imóveis urbanos com total aderência às diretrizes da norma NBR 14653.

A API segue a arquitetura RESTful, trafegando payloads exclusivamente no formato JSON codificados em UTF-8.

Autenticação HTTP Bearer

As requisições aos endpoints da API do CastleR exigem autenticação via token exclusivo fornecido para a sua empresa. O token deve ser enviado pelo cabeçalho Authentication-Token.

Authentication-Token: Bearer SEU_TOKEN_EXCLUSIVO_DA_EMPRESA

Modos de Execução: Síncrono vs. Assíncrono

Para atender às necessidades específicas da sua integração, considerando a complexidade da avaliação e o tempo de resposta desejado, disponibilizamos dois modos de processamento:

Estrutura de Endpoints por Tipologia

Cada tipo de imóvel possui um motor de cálculo ajustado com variáveis específicas. Substitua a variável {tipologia} pela categoria desejada (apartamentos, casas ou terrenos):

1. Apartamentos

2. Casas

3. Terrenos

Exemplos de Chamada de Avaliação (POST)

Monte abaixo a requisição desejada selecionando a Tipologia, a Modalidade e a Linguagem de Programação:

Consulta de Avaliação Finalizada (GET)

Caso você necessite consultar novamente uma avaliação processada anteriormente (seja ela iniciada via método Síncrono ou Assíncrono) ou baixar os resultados completos de cálculo, incluindo o memorial da avaliação em formato DOCX ou PDF, utilize o endpoint de consulta por GUID:

Parâmetros de Requisição:

Exemplo de Resposta de Sucesso (HTTP 200 OK):

O campo memorial_docx_base64 contém o arquivo do laudo em formato Microsoft Word (DOCX) codificado em Base64, pronto para ser decodificado e salvo em disco:

{
  "status": "Concluido",
  "sucesso": true,
  "avaliacao": {
    "resultados": [
      {
        "inferencia": {
          "venda_valor_monetario": "R$ 1.520.000,00",
          "venda_valor_em_centavos": 152000000,
          "venda_iva_maximo_monetario": "R$ 1.560.000,00",
          "venda_iva_maximo_em_centavos": 156000000,
          "venda_iva_minimo_monetario": "R$ 1.480.000,00",
          "venda_iva_minimo_em_centavos": 148000000
        }
      }
    ]
  },
  "memorial_docx_base64": "UESDBBQABgAIAAAAIQAkdeL... [String Base64 do Documento Word Completo] ..."
}

Portal do Desenvolvedor & Documentação Interativa (Swagger)

Para desenvolvedores e gestores de TI, disponibilizamos um portal dedicado à integração. Acesse a página oficial da ferramenta para explorar todas as funcionalidades e ter acesso imediato à documentação técnica via Swagger:

Através deste portal, é possível verificar os endpoints, schemas, testar requisições interativas em tempo real, explorar exemplos completos de payloads e entender a estrutura de dados para acelerar a implementação da API em seu ecossistema digital.

Validação de Webhooks (HMAC SHA-256)

Ao utilizar chamadas assíncronas, o CastleR efetua uma requisição HTTP POST no seu endpoint assim que o cálculo for concluído.

Para confirmar que a notificação foi enviada legitimamente pelo CastleR e não sofreu adulteração, o sistema gera uma assinatura digital e a envia no cabeçalho x-signature-sha256.

Códigos de Status HTTP & Regras