API do Simulador Habitacional

Começando

1. Assine o plano API e entre no painel em API e integrações.
2. Crie uma chave (ela aparece só uma vez).
3. Envie a chave em todo pedido: Authorization: Bearer sh_live_…

Endereço base: https://www.simuladorhabitacional.com/api/v1 · JSON em UTF-8 · datas de nascimento em dd/mm/aaaa, demais datas em ISO 8601 · valores em reais (número, ponto decimal).

curl https://www.simuladorhabitacional.com/api/v1/clientes?limite=5 \
  -H "Authorization: Bearer sh_live_SUA_CHAVE"

// JavaScript
const r = await fetch("https://www.simuladorhabitacional.com/api/v1/simulacoes", {
  method: "POST",
  headers: { Authorization: "Bearer sh_live_SUA_CHAVE", "Content-Type": "application/json" },
  body: JSON.stringify({ renda: 3500, nascimento: "10/05/1990", cidade: "Goiânia - GO", valor_imovel: 230000 }),
});
const simulacao = await r.json();   // simulacao.link → página do resultado com a sua marca

Erros e limites

Erros vêm como { "erro": { "codigo": "…", "mensagem": "…" } }.

Listas: até 500 por página. Criação em lote: até 500 registros por pedido. Cada chave só enxerga os dados da própria conta.

Conta

Dados da conta dona da chave.

{ "nome": "Juliana Andrade", "plano": "api", "acesso_ate": "2027-10-18", "formulario_url": "https://…/f/juliana-andrade" }

Clientes (CRM)

Os clientes do funil. Campos: nome*, telefone, email, renda, nascimento (dd/mm/aaaa), cidade ("Cidade - UF"), valor_imovel, entrada, saldo_fgts, fgts3, mais_de_um, possui_imovel, observacoes, respostas (objeto livre), etapa_id ou etapa (nome), corretor_id ou corretor (nome), imovel_id, correspondente_id, motivo_perda_id, valor_venda.

{ "dados": [ { "id": "…", "nome": "Maria Souza", "telefone": "62999990000", "renda": 3500, "etapa_id": "…", "criado_em": "…" } ], "pagina": 1, "limite": 100, "total": 1 }

{ "nome": "Maria Souza", "telefone": "62999990000", "renda": 3500, "nascimento": "10/05/1990", "cidade": "Goiânia - GO", "valor_imovel": 230000, "etapa": "Simulado", "corretor": "Ana" }

{ "observacoes": "Ligar amanhã", "valor_venda": 225000 }

{ "etapa": "Aprovado" }

Simulações

Simulação completa com as regras oficiais da Caixa e do Minha Casa Minha Vida (subsídio do FGTS, PRICE e SAC) e comparação com os outros bancos.

{ "renda": 3500, "nascimento": "10/05/1990", "cidade": "Goiânia - GO", "valor_imovel": 230000, "fgts3": true, "saldo_fgts": 8000 }

{ "id": "…", "link": "https://…/s/…", "programa": "Minha Casa Minha Vida – Faixa 2", "subsidio": 9850.2, "prazo_maximo_meses": 420,
  "sac": { "financiamento": 176000, "primeira_parcela": 1049.6, "taxa_efetiva": 0.0723, "prazo_meses": 420, "limitado_por": "renda" },
  "price": { … }, "bancos": [ { "banco": "Caixa", "taxa_efetiva": 0.0723, "sac": { "financiamento": 176000, "primeira_parcela": 1049.6 } }, … ],
  "renda_ideal": { "price": 3700, "sac": 4100, "credito_price": 186553, "credito_sac": 184000 }, "avisos": [ … ] }

Formulários

Cada conta tem um formulário (/f/<link>) e cada corretor da equipe tem o seu. Pela API você lê e configura as perguntas e envia respostas como se o cliente tivesse preenchido.

{ "mensagem": "Preencha e receba sua simulação", "cor": "#0e7490", "perguntas": [ { "id": "nome", "rotulo": "Seu nome" }, { "id": "telefone", "rotulo": "WhatsApp" }, { "rotulo": "Tem carro financiado?", "tipo": "sim_nao", "obrigatorio": true } ] }

{ "nome": "Carlos Lima", "telefone": "62988887777", "renda": "4100", "cidade": "Anápolis - GO", "Tem carro financiado?": "Não", "formulario": "ana-corretora" }

Imóveis e páginas de captação

Campos: nome*, construtora, cidade, bairro, valor, valor_avaliacao, tipo (apartamento|casa|terreno), metragem, operacao (novo|usado), observacoes, ativo, foto_url, site_url. Página do imóvel (/i/<slug>): publicado, slug, finalidade (venda|aluguel), titulo, descricao, fotos (lista de URLs, a primeira é a capa), diferenciais (lista), quartos, banheiros, vagas, endereco, video_url, valor_aluguel, condominio, iptu, unidades_disponiveis, entrega, corretor_id (quem recebe os clientes da página). Clientes vindos da página chegam com origem "landing" e imovel_id.

{ "nome": "Residencial Ipê", "cidade": "Anápolis - GO", "valor": 215000, "tipo": "casa", "metragem": 52 }

Corretores e correspondentes

Campos: nome*, telefone, email, empresa, ativo. O acesso (login) de cada corretor é criado no painel.

{ "nome": "Ana Corretora", "telefone": "62999990000" }

Depoimentos

Depoimentos exibidos nas páginas. Campos: nome*, texto*, foto_url, nota (1 a 5), publicado, imovel_id (vazio = geral: vitrine e todas as páginas), ordem.

{ "nome": "Fernanda Lima", "texto": "Consegui meu subsídio!", "nota": 5 }

Etapas, motivos de perda e mensagens

Configuração do funil.

Webhooks

Avisos enviados para o seu sistema em até 1 minuto. Eventos: cliente.criado, cliente.atualizado, cliente.etapa_alterada, cliente.excluido, simulacao.criada. Se o seu endereço não responder 2xx, tentamos de novo até 6 vezes.

{ "url": "https://seusistema.com.br/webhooks/simulador", "eventos": ["cliente.criado", "cliente.etapa_alterada"] }

Conferir a assinatura dos webhooks

Cada aviso traz X-Simulador-Evento e X-Simulador-Assinatura: sha256=… — o HMAC-SHA256 do corpo com o segredo do webhook. Corpo: { "id", "evento", "criado_em", "dados" }. Responda 2xx em até 10 segundos.

// Node.js (Express)
import crypto from "node:crypto";
app.post("/webhooks/simulador", express.raw({ type: "application/json" }), (req, res) => {
  const esperado = "sha256=" + crypto.createHmac("sha256", process.env.SEGREDO).update(req.body).digest("hex");
  if (req.get("x-simulador-assinatura") !== esperado) return res.sendStatus(401);
  const aviso = JSON.parse(req.body);   // { id, evento, criado_em, dados }
  res.sendStatus(200);
});

// PHP
$corpo = file_get_contents("php://input");
$ok = hash_equals("sha256=" . hash_hmac("sha256", $corpo, $segredo), $_SERVER["HTTP_X_SIMULADOR_ASSINATURA"] ?? "");