Inicio rápido

Crea una clave

En ByDomu, ve a Configuración › API Keys. Para tu página web, una publicable (domu_pk_live_); para un servidor, una secreta (domu_sk_live_). Las secretas de solo lectura vienen con Business y Enterprise, con 60 peticiones por minuto. La clave completa se ve una sola vez: guárdala en una variable de entorno.

export BYDOMU_API_KEY="domu_sk_live_…"

Tu primera petición

GET /me no pide ningún permiso: dice de qué inmobiliaria es la clave, su plan y qué permisos tiene.

curl https://api.bydomu.com/v1/me \
  -H "X-API-Key: $BYDOMU_API_KEY"

{
  "data": {
    "apiKeyId": "clx1key001",
    "organization": { "id": "clx1org001", "plan": "BUSINESS", "isActive": true },
    "scopes": ["portal:read", "contacts:read"],
    …
  }
}

Lee un listado

Los listados se paginan con page y pageSize y traen meta.total y meta.totalPages. Para contactos hace falta contacts:read.

curl -G https://api.bydomu.com/v1/contacts \
  -H "X-API-Key: $BYDOMU_API_KEY" \
  -d page=1 -d pageSize=20

Si algo falla

• 401Falta el encabezado X-API-Key o la clave no es válida (la API no acepta Authorization: Bearer).
• 403A la clave le falta el permiso, es una secreta usada desde el navegador o el nivel de la cuenta no la permite.
• 429Pasaste el límite por minuto. Espera los segundos de Retry-After.