Referencia de la API

La API v1 de ByDomu es REST con JSON. Esta referencia se genera desde la spec OpenAPI, que a su vez sale del código de las rutas: cada endpoint trae sus parámetros, el permiso que pide y ejemplos. No hay SDK oficial; con la spec puedes generar tu cliente.

Dirección base
https://api.bydomu.com/v1

Autenticación

La clave va en el encabezado X-API-Key (no se acepta Authorization: Bearer). Se crea en ByDomu, en Configuración › API Keys, y la completa se ve una sola vez.

cURL
curl https://api.bydomu.com/v1/me \
  -H "X-API-Key: $BYDOMU_API_KEY"
domu_pk_live_publicable
Para páginas web y el navegador. Solo: portal:read, leads:write, booking:write, finder:write, events:write.
domu_sk_live_secreta
Solo desde un servidor: con Origin (navegador) responde 403 SECRET_KEY_IN_BROWSER. Cualquier permiso.
domu_live_legado
Claves creadas antes de los tipos. Siguen funcionando igual.

Niveles de acceso

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

Paginación

Los listados reciben page (desde 1) y pageSize, y responden con los datos y el total. Cada endpoint dice su pageSize máximo. Contactos, negocios y tareas aceptan además cursor.

JSON
{
  "data": [ … ],
  "meta": { "total": 64, "page": 1, "pageSize": 12, "totalPages": 6 }
}

Errores

Siempre con la misma forma. Los datos que no pasan la validación del esquema responden 400 con la lista de problemas.

JSON
{
  "error": {
    "code": "FORBIDDEN",
    "message": "La API key no tiene el scope requerido: contacts:read"
  }
}
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

Límites

Una clave publicable tiene 300 peticiones y 60 escrituras por minuto; una secreta, 60 y 30. Soporte puede aprobar más. Cada respuesta trae X-RateLimit-Limit, X-RateLimit-Remaining y X-RateLimit-Reset; al pasarte, 429 RATE_LIMITED con Retry-After.

En cualquier escritura puedes mandar Idempotency-Key: un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original con Idempotency-Status: replayed. Vive 24 horas.

Recursos

Cuenta1 endpoint · Información de la API key y la organizaciónPortal1 endpoint · Configuración del portal inmobiliarioPropiedades6 endpoints · Inventario publicado en el portal; crear y actualizar propiedades del CRMAgentes2 endpoints · Agentes con propiedades publicadas en el portalLeads2 endpoints · Formularios públicos de contacto y solicitud de visitaBuscador1 endpoint · Buscador inteligente de propiedades para prospectosReservas4 endpoints · Agendamiento de citas con agentes desde páginas públicasContactos4 endpoints · Contactos del CRM (clientes, propietarios, prospectos)Embudos2 endpoints · Pipelines de ventas y arriendos con etapas configurablesNegocios5 endpoints · Oportunidades comerciales del pipelineTareas4 endpoints · Tareas asignadas al equipo comercialDocumentos2 endpoints · Archivos adjuntos a negociosSobres de firma2 endpoints · Sobres de firma electrónicaConversaciones4 endpoints · Mensajes de WhatsApp con los contactosCitas5 endpoints · Citas agendadas con contactos (visitas, reuniones, llamadas)Equipo2 endpoints · Miembros de la inmobiliariaEtiquetas1 endpoint · Etiquetas para clasificar contactos y negociosCampos personalizados1 endpoint · Definiciones de campos personalizadosComisiones2 endpoints · Comisiones generadas por negocios cerradosContabilidad2 endpoints · Ingresos y egresosArriendos2 endpoints · Contratos de arrendamiento con sus pagos y mantenimientosNotas1 endpoint · Notas rápidas enganchadas a contactos, negocios y propiedadesEventos3 endpoints · Catálogo de eventos de dominio, histórico reciente y analítica del portalWebhooks4 endpoints · Suscripciones HTTP salientes para Zapier, n8n, Make e integraciones propias