Início rápido

Crie uma chave

No ByDomu, vá em Configurações › API Keys. Para seu site, uma publicável (domu_pk_live_); para um servidor, uma secreta (domu_sk_live_). As secretas somente leitura vêm com Business e Enterprise, com 60 requisições por minuto. A chave completa aparece uma só vez: guarde-a em uma variável de ambiente.

export BYDOMU_API_KEY="domu_sk_live_…"

Sua primeira requisição

GET /me não pede nenhuma permissão: diz de qual imobiliária é a chave, seu plano e quais permissões tem.

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"],
    …
  }
}

Leia uma lista

As listas são paginadas com page e pageSize e trazem meta.total e meta.totalPages. Para contatos é preciso contacts:read.

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

Se algo falhar

• 401Falta o cabeçalho X-API-Key ou a chave não é válida (a API não aceita Authorization: Bearer).
• 403Falta a permissão à chave, é uma secreta usada no navegador ou o nível da conta não a permite.
• 429Você passou do limite por minuto. Espere os segundos de Retry-After.