farolı
EntrarCrear comunidad
// API REFERENCE v1

Faroli API — tu data es tuya.

API REST documentada para integrar Faroli con tu CRM, Zapier, n8n o backend custom. Sin lock-in, sin paywall — todo plan Pro+ incluye API access.

1. Autenticación

Las peticiones se autentican con Bearer Token en el header. Crea tu API key en /communities/admin/settings.

curl https://faroli.io/api/v1/members \
  -H "Authorization: Bearer fk_live_xxxxxxxxxxxxx"
💡 Las API keys son por community. No las compartas — funcionan como passwords. Si filtraste una, rótala en settings/api inmediatamente.

2. Rate Limits

  • Free / Creator: 60 req/min
  • Pro: 300 req/min
  • Business: 1,200 req/min
  • Enterprise: custom

Headers de respuesta: X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset.

3. Endpoints principales

GET/api/v1/membersLista miembros de tu community
GET/api/v1/members/:idDetalle de un miembro
POST/api/v1/membersInvita un nuevo miembro
GET/api/v1/coursesLista cursos publicados
POST/api/v1/coursesCrea un curso
GET/api/v1/courses/:id/lessonsLecciones de un curso
GET/api/v1/eventsLista eventos programados
POST/api/v1/eventsCrea un evento
GET/api/v1/subscriptionsSubscripciones activas
POST/api/v1/broadcastsEnvía email broadcast
GET/api/v1/analyticsMétricas (MRR, churn, signups)
GET/api/v1/exportExport completo en JSON

4. Webhooks

Faroli puede notificar tu backend cuando suceden eventos en tu community. Configura tus webhook URLs en /communities/admin/settings/webhooks.

  • member.created — nuevo signup
  • subscription.activated — nuevo pago
  • subscription.canceled — cancelación
  • lesson.completed — lección terminada
  • course.completed — curso terminado
  • event.rsvp — RSVP a evento
  • level.up — miembro sube de nivel

Cada webhook lleva X-Faroli-Signature con HMAC-SHA256 del payload. Validalo siempre antes de procesar.

5. Códigos de error

HTTPSignificado
200OK
201Created
400Bad request — body inválido
401API key falta o inválida
403Sin permiso para este recurso
404Recurso no existe
429Rate limit excedido
500Error interno (raro, notificame: hi@faroli.io)

6. SDKs y wrappers

Versiones oficiales mantenidas por Faroli:

  • Node.js / TypeScript: npm install @faroli/sdk (próximamente)
  • Python: pip install faroli (próximamente)
  • Zapier: integración nativa (próximamente)
  • n8n: nodo oficial (próximamente)
  • Make (Integromat): módulo (próximamente)
💡 Mientras tanto: la API REST es estándar HTTP+JSON, podés usar cualquier cliente (fetch, axios, requests, curl).