API ImobyFlow

Não é do TI? Portais, anúncios, site e o link do CRM se ligam sem código — veja as integrações.

A primeira chamada

Ponha a chave numa variável de ambiente (IMOBYFLOW_API_KEY) e chame:

curl -X GET 'https://api.imobyflow.com.br/v1/me' \
  -H "Authorization: Bearer $IMOBYFLOW_API_KEY" \
  -H 'Accept-Language: pt-BR'

Ou direto daqui: cada rota da referência tem o botão Experimente, que chama a API com a sua chave e explica cada campo da resposta. Escrita ali sai sempre em modo ensaio — nada é gravado.

O básico

• Endereço: https://api.imobyflow.com.br/v1. Tudo em HTTPS e JSON (UTF-8).
• A chave vai no cabeçalho Authorization: Bearer imob_live_… — nunca na URL e nunca no navegador do seu cliente. A chave é da empresa, não de uma pessoa: a integração não morre quando alguém sai da equipe.
• Datas em ISO 8601, em UTC. Valores em reais.
• Os valores de código (VENDA, ACTIVE, APARTAMENTO) são os da plataforma, sem tradução. Accept-Language: en traduz rótulos e mensagens de erro.
• Toda escrita aceita ?dryRun=true: valida e diz o que aconteceria, sem gravar. Os exemplos deste portal já vêm assim.

Quem pode usar

A API completa é liberada pela ImobyFlow, conta a conta, para imobiliárias a partir de 2.000 imóveis e para construtoras, com a assinatura em dia (o período de teste conta). Cada liberação diz quais permissões a conta pode dar às suas chaves.

O que a API não faz

• Não busca no estoque dos parceiros. O Radar já entrega o parceiro certo, no contexto certo — a oportunidade.
• Não mexe em plano, cobrança, cartão, e-mail ou senha. Isso é gesto do dono, no painel.
• Não aprova o próprio imóvel: a análise da ImobyFlow continua igual para quem integra.

Ferramentas

Tudo sai do mesmo contrato desta documentação e é atualizado a cada versão.

SDKs oficiais

Um arquivo por linguagem, gerado do mesmo contrato a cada versão: um método para cada rota, as páginas percorridas sozinhas, nova tentativa que nunca duplica uma escrita e o erro com o code da API. Sem dependência: TypeScript para Node 18+, Python 3.9+ só com a biblioteca padrão e PHP 8 com curl.

• TypeScript / Nodeimobyflow.ts
• Pythonimobyflow.py
• PHPImobyFlow.php

// curl -o imobyflow.ts https://imobyflow.com.br/desenvolvedores/sdk/typescript
import { ImobyFlow, ImobyFlowError } from './imobyflow';

const api = new ImobyFlow(process.env.IMOBYFLOW_API_KEY!);
const { data: conta } = await api.getMe();

// Todas as páginas, sem lidar com o cursor:
for await (const imovel of api.listPropertiesAll({ status: 'ACTIVE' })) {
  console.log(imovel.id, imovel.externalRef);
}

// Escrita em modo ensaio: nada é gravado. Tire o dryRun para gravar.
try {
  await api.putPropertyByRef('AP1234', { title: 'Apartamento 3 quartos' }, { dryRun: true });
} catch (e) {
  if (e instanceof ImobyFlowError) console.error(e.code, e.requestId, e.invalidParams);
}

Baixe e ponha no seu projeto. Endereços fixos — sdk/typescript, sdk/python e sdk/php — para o seu build buscar a versão nova.

Para assistentes de IA

Servidor MCP: o agente opera a conta

Claude, ChatGPT, Copilot e Cursor leem e atualizam a carteira, os clientes, o Radar e as parcerias pelo endereço https://api.imobyflow.com.br/mcp, com a mesma chave da API e as mesmas permissões. Toda escrita roda primeiro em modo ensaio e só grava quando a pessoa confirma. Apagar, aceitar oferta da Captação e mexer em webhooks ficam de fora.

claude mcp add --transport http imobyflow https://api.imobyflow.com.br/mcp \
  --header "Authorization: Bearer $IMOBYFLOW_API_KEY"

A documentação para o seu assistente ler

• llms.txt
• Referência completa (Markdown, para IA)

Por onde seguir

• Conceitos e regras
• Referência
• Eventos e webhooks
• Mudanças e versões