ByDomuDevelopers
Crear clave

ByDomu para desarrolladores

Construye sobre los datos de tu inmobiliaria.

Una API REST para leer y escribir en el CRM, webhooks para enterarte de lo que pasa y un servidor MCP para que tu IA lo consulte. Todo con la clave de tu inmobiliaria.

Inicio rápidoReferencia de la API
REST + JSONOpenAPI 3.0api.bydomu.com/v1
Petición
# 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_…"
Respuesta · 200
{
  "data": [
    { "code": "P-0042", "title": "Apartamento en Laureles",
      "transactionType": "SALE", "bedrooms": 2, "area": 78, … }
  ],
  "meta": { "total": 1, "page": 1, "pageSize": 12, "totalPages": 1 }
}

Qué puedes hacer

Leer tu CRM

Contactos, negocios y embudos, tareas, citas, conversaciones, equipo, etiquetas, comisiones, contabilidad, arriendos, documentos y sobres de firma.

GET/contactsGET/dealsGET/appointments

Escribir en el CRM

Con aprobación

Crea y actualiza contactos, negocios, tareas, citas, propiedades y notas, y mueve negocios de etapa. Con Idempotency-Key para no duplicar.

POST/contactsPOST/deals/{id}/move

Webhooks

Con aprobación

Cualquier evento del catálogo, firmado con HMAC-SHA256.

Servidor MCP

Nueve herramientas de solo lectura en mcp.bydomu.com/mcp.

Autenticación

Cada petición lleva la clave en el encabezado X-API-Key. Las creas en ByDomu, en Configuración › API Keys; la completa se ve una sola vez.

Publicabledomu_pk_live_

Para tu página web y el navegador: puede ir en el código de la página.

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

Solo lo público y recibir clientes.

Secretadomu_sk_live_

Solo desde un servidor: Zapier, Make, n8n, tu backend o un cliente MCP.

Cualquier permiso: *:read y, con aprobación, *:write

Desde un navegador responde 403.

Las claves de antes (domu_live_) siguen funcionando igual mientras las revisamos.

Niveles de acceso

Lo que puede hacer una clave depende del plan y de lo que apruebe soporte. Nunca hay API durante la prueba gratis ni con el correo sin verificar.

NivelPlanesCómo se obtiene
1Claves publicables300 peticiones y 60 escrituras por minuto · hasta 5 clavesCualquier plan pagadoSin solicitud
2Secretas de solo lectura60 peticiones por minuto · hasta 2 clavesBusiness · EnterpriseAutomático
3Escrituras, mensajes, webhooks y límites altosA la medida de lo aprobadoCualquier plan pagadoRevisión de soporte

Más límite o más permisos se piden desde Configuración › API Keys.

Servidor MCP

Solo lectura

Claude, la API de OpenAI o cualquier cliente MCP consulta tu inmobiliaria con una clave secreta. Hereda los permisos, los límites y el registro de la API.

POSThttps://mcp.bydomu.com/mcp
search_propertiesget_propertysearch_contactsget_contactlist_appointmentslist_pipelineslist_dealslist_pending_tasksget_summary
Guía: Conecta ByDomu a Claude

Webhooks

Con aprobación

Te avisamos por POST de cualquier evento del catálogo: un tipo exacto, un objeto entero o todos. Firmado con HMAC-SHA256 en X-Domu-Signature.

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

Hasta 5 intentos (0 s, 5 s, 30 s, 2 min y 10 min) ante error de red, 429 o 5xx. Responde 2xx en menos de 10 s.

POST/webhooksGET/eventsVerificar la firma

Límites y paginación

Cada respuesta dice cuánto te queda del minuto. Los listados se paginan con page y pageSize y traen meta.total y meta.totalPages.

Encabezados de respuesta
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 41
Retry-After: 41            # solo con 429
Idempotency-Status: replayed  # reintento con la misma Idempotency-Key

Errores

Siempre con la misma forma: { "error": { "code", "message" } }.

400VALIDATION_ERRORDatos de entrada inválidos
401UNAUTHORIZEDClave faltante o inválida
402PAYMENT_REQUIREDCuenta en solo lectura: escritura rechazada
403FORBIDDENLa clave no tiene ese permiso
403SECRET_KEY_IN_BROWSERClave secreta usada desde un navegador
403API_ACCESS_REQUIREDEl nivel de la cuenta no permite esta clave
403PLAN_LIMIT_REACHEDSe alcanzó un tope del plan
404NOT_FOUNDRecurso no encontrado
409IDEMPOTENCY_CONFLICTIdempotency-Key reutilizada con otro cuerpo
429RATE_LIMITEDLímite por minuto superado

Changelog

Ver todo
  • MCPServidor MCP de solo lectura en mcp.bydomu.com, con nueve herramientas.
  • AccesoNiveles de acceso: publicables sin solicitud, secretas de lectura en Business y Enterprise, lo demás con aprobación.
  • ClavesClaves publicables (domu_pk_live_) y secretas (domu_sk_live_). Las de legado siguen igual.
  • APIEscritura en el CRM, webhooks para Zapier, n8n y Make, y OpenAPI 3.0.

Referencia completa

Cada endpoint con sus parámetros, el permiso que pide, la respuesta y ejemplos en cURL, JavaScript y Python.

No hay SDK oficial: es REST con JSON y el OpenAPI sirve para generar tu cliente.

Abrir la referenciaopenapi.json