ByDomu para desenvolvedores

Construa sobre os dados da sua imobiliária.

Uma API REST para ler e escrever no CRM, webhooks para saber o que acontece e um servidor MCP para que sua IA consulte. Tudo com a chave da sua imobiliária.

Início rápido Referência da API

REST + JSONOpenAPI 3.0api.bydomu.com/v1

Requisição

# Tus propiedades publicadas en Laureles, de 2 alcobas o más
curl -G "https://api.bydomu.com/v1/properties" \
  -d neighborhood=Laureles -d bedroomsMin=2 \
  -H "X-API-Key: domu_sk_live_…"

Resposta · 200

{
  "data": [
    { "code": "P-0042", "title": "Apartamento en Laureles",
      "transactionType": "SALE", "bedrooms": 2, "area": 78, … }
  ],
  "meta": { "total": 1, "page": 1, "pageSize": 12, "totalPages": 1 }
}

O que você pode fazer

Ler seu CRM

Contatos, negócios e funis, tarefas, compromissos, conversas, equipe, etiquetas, comissões, contabilidade, aluguéis, documentos e envelopes de assinatura.

GET/contacts GET/deals GET/appointments

Escrever no CRM

Com aprovação

Crie e atualize contatos, negócios, tarefas, compromissos, imóveis e notas, e mova negócios de etapa. Com Idempotency-Key para não duplicar.

POST/contacts POST/deals/{id}/move

Seu site

Com uma chave publicável: imóveis publicados, filtros, corretores, formulários de contato, visitas, reservas e buscador guiado.

GET/properties POST/leads POST/booking/{slug}

Webhooks

Com aprovação

Qualquer evento do catálogo, assinado com HMAC-SHA256.

Servidor MCP

Nove ferramentas somente leitura em mcp.bydomu.com/mcp.

Autenticação

Cada requisição leva a chave no cabeçalho X-API-Key. Você as cria no ByDomu, em Configurações › API Keys; a completa aparece uma só vez.

Publicáveldomu_pk_live_

Para seu site e o navegador: pode ir no código da página.

portal:read · leads:write · booking:write · finder:write · events:write

Só o público e receber clientes.

Secretadomu_sk_live_

Só de um servidor: Zapier, Make, n8n, seu backend ou um cliente MCP.

Qualquer permissão: *:read e, com aprovação, *:write

Em um navegador responde 403.

As chaves antigas (domu_live_) continuam funcionando igual enquanto as revisamos.

Níveis de acesso

O que uma chave pode fazer depende do plano e do que o suporte aprovar. Nunca há API durante o teste grátis nem com o e-mail sem verificar.

NívelPlanosComo se obtém

1Chaves publicáveis300 requisições e 60 escritas por minuto · até 5 chavesQualquer plano pagoSem solicitação

2Secretas somente leitura60 requisições por minuto · até 2 chavesBusiness · EnterpriseAutomático

3Escritas, mensagens, webhooks e limites altosSob medida do aprovadoQualquer plano pagoRevisão do suporte

Mais limite ou mais permissões são pedidos em Configurações › API Keys.

Servidor MCP

Somente leitura

O Claude, a API da OpenAI ou qualquer cliente MCP consulta sua imobiliária com uma chave secreta. Herda as permissões, os limites e o registro da API.

POSThttps://mcp.bydomu.com/mcp

search_propertiesget_propertysearch_contactsget_contactlist_appointmentslist_pipelineslist_dealslist_pending_tasksget_summary

Guia: Conecte o ByDomu ao Claude

Webhooks

Com aprovação

Avisamos por POST de qualquer evento do catálogo: um tipo exato, um objeto inteiro ou todos. Assinado com HMAC-SHA256 em X-Domu-Signature.

contact.createddeal.stage_changeddeal.wonappointment.confirmedproperty.price_changedlease.expiringmessage.receiveddeal.**

Até 5 tentativas (0 s, 5 s, 30 s, 2 min e 10 min) em erro de rede, 429 ou 5xx. Responda 2xx em menos de 10 s.

POST/webhooks GET/events Verificar a assinatura

Limites e paginação

Cada resposta diz quanto resta do minuto. As listas são paginadas com page e pageSize e trazem meta.total e meta.totalPages.

Cabeçalhos de resposta

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 41
Retry-After: 41            # só com 429
Idempotency-Status: replayed  # nova tentativa com a mesma Idempotency-Key

Erros

Sempre com o mesmo formato: { "error": { "code", "message" } }.

400VALIDATION_ERRORDados de entrada inválidos

401UNAUTHORIZEDChave ausente ou inválida

402PAYMENT_REQUIREDConta somente leitura: escrita recusada

403FORBIDDENA chave não tem essa permissão

403SECRET_KEY_IN_BROWSERChave secreta usada em um navegador

403API_ACCESS_REQUIREDO nível da conta não permite esta chave

403PLAN_LIMIT_REACHEDUm limite do plano foi atingido

404NOT_FOUNDRecurso não encontrado

409IDEMPOTENCY_CONFLICTIdempotency-Key reutilizada com outro corpo

429RATE_LIMITEDLimite por minuto excedido

Changelog

Ver tudo

26 set 2026MCPServidor MCP somente leitura em mcp.bydomu.com, com nove ferramentas.
26 set 2026AcessoNíveis de acesso: publicáveis sem solicitação, secretas de leitura no Business e no Enterprise, o resto com aprovação.
26 set 2026ChavesChaves publicáveis (domu_pk_live_) e secretas (domu_sk_live_). As legadas continuam iguais.
22 set 2026APIEscrita no CRM, webhooks para Zapier, n8n e Make, e OpenAPI 3.0.

Referência completa

Cada endpoint com seus parâmetros, a permissão que pede, a resposta e exemplos em cURL, JavaScript e Python.

Não há SDK oficial: é REST com JSON e o OpenAPI serve para gerar seu cliente.

Abrir a referência openapi.json