ImobyFlowParcerias Imobiliárias
Navegar na documentação
English

Mudanças e versões

A versão atual é v1 (contrato 1.0.0). O que muda é anunciado aqui antes de valer.

Política de versões

  • Acrescentar não quebra: campos, eventos, rotas e valores novos podem chegar a qualquer momento. O seu sistema deve tolerar campo que ele não conhece.
  • O que quebra uma integração existente sai numa versão nova (/v2). A versão anterior continua funcionando por pelo menos 12 meses depois do aviso, publicado aqui e mandado por e-mail ao dono da conta.
  • Os valores de código (VENDA, ACTIVE, os subtipos) são os mesmos da plataforma, sem tradução no meio.

O que mudou

    • SDKs oficiais em TypeScript, Python e PHP, gerados deste contrato: um método por rota, as páginas percorridas sozinhas, nova tentativa que nunca duplica uma escrita e a conferência da assinatura do webhook.
    • Exemplos de resposta (sucesso e erros) na coleção do Postman e no OpenAPI. A coleção pública do Postman acompanha cada versão.
    • POST /v1/feed/sync: o seu sistema avisa que a carteira mudou e a ImobyFlow busca o link do feed na hora, sem esperar as 6 horas; GET /v1/feed mostra o resultado.
    • Servidor MCP em https://api.imobyflow.com.br/mcp: agentes de IA leem e atualizam a conta com a mesma chave. Toda escrita roda em ensaio e só grava com confirmação.

  2. 1.0.0

    • Portal do desenvolvedor em português e inglês, gerado do contrato OpenAPI 3.1.
    • Uma página por código de erro — o endereço que vem no type de cada erro.
    • Coleção do Postman, OpenAPI em JSON e YAML e llms.txt para assistentes de IA.
    • Botão "Experimente" em cada rota: chama a API do navegador com a sua chave (leitura de verdade, escrita sempre em modo ensaio) e explica cada campo da resposta — o JSON anotado.

    • Webhooks assinados (Standard Webhooks), com nova tentativa por cerca de 21 horas, desligamento automático, reenvio e evento de teste.
    • Eventos (GET /v1/events): o que mudou na conta, em ordem, com 30 dias de memória.
    • Avisos por e-mail: chave vencendo, cota do mês em 80% e 100%, endereço de webhook desligado.
    • Lotes de até 500 imóveis ou clientes.
    • Captação: a mesa, os aceitos e o aceite, com permissão e termo próprios.
    • Ações: descartar e restaurar oportunidade, mover parceria e a lixeira com a trava de encolhimento.
    • Escrita de clientes (código do seu sistema, vínculo pelo contato, consentimento) e de imóveis (fotos por endereço, modo ensaio, Idempotency-Key).
    • Leitura: imóveis, clientes, oportunidades, parcerias, equipe e lançamentos.

    • A fundação: chaves por conta, liberação conta a conta, GET /v1/me, listas de valores e o catálogo de cidades e bairros.