API pública v1

REST · JSON · autenticação por chave de API

Autenticação

Envie sua chave no header X-Api-Key em todas as requisições. Gere chaves em Configurações → API.

curl https://seu-dominio.com/api/public/v1/imoveis \
  -H "X-Api-Key: <SUA_CHAVE>"

GET/api/public/v1/imoveis

Lista imóveis publicados do tenant. Parâmetros de query:

tipo — apartamento, casa, comercial, terreno…
finalidade — venda, locacao
cidade, uf
preco_min, preco_max
limit (padrão 20, máx 100)

{
  "items": [
    {
      "id": "uuid",
      "titulo": "Apartamento 3 quartos",
      "tipo": "apartamento",
      "finalidade": "venda",
      "preco": 750000,
      "cidade": "São Paulo",
      "uf": "SP",
      "url": "https://.../imovel/<slug>"
    }
  ],
  "count": 1
}

POST/api/public/v1/leads

Cria um lead no funil do tenant.

{
  "nome": "João da Silva",
  "email": "joao@example.com",
  "telefone": "+55 11 99999-0000",
  "mensagem": "Tenho interesse no imóvel",
  "imovel_id": "uuid (opcional)"
}

Resposta 201:

{ "id": "uuid-do-lead" }

Webhooks de saída

Configure URLs em Configurações → Webhooks para receber eventos: lead.created, lead.atribuido, lead.convertido, imovel.publicado, contrato.assinado, contrato.ativo.

Cada entrega é assinada via header X-Imob365-Signature com HMAC-SHA256 do corpo usando o segredo do webhook.

Limites & boas práticas

Use HTTPS sempre.
Não compartilhe sua chave em frontend público.
Rotacione a chave em caso de suspeita.
Webhooks: responda com 2xx em até 10s; falhas são re-tentadas.