farolı
EntrarCrear comunidad
// API REFERENCE v1

Faroli API — tu data es tuya.

API REST documentada para leer tus datos desde tu backend o CRM. Sin lock-in: tu data siempre es tuya. Integraciones Zapier y n8n en preparación.

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/me \
  -H "Authorization: Bearer faroli_xxxxxxxxxxxxx"
💡 Las API keys son por community. No las compartas — funcionan como passwords. Si filtraste una, rótala en /communities/admin/settings inmediatamente.

2. Rate Limits (en preparación)

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

Estos límites entrarán en vigor cuando la API salga de beta — hoy no se aplican. Headers de respuesta previstos: X-RateLimit-Limit,X-RateLimit-Remaining,X-RateLimit-Reset.

3. Endpoints disponibles hoy

GET/api/v1/meTu cuenta + community asociada al token
GET/api/v1/coursesLista cursos publicados
GET/api/v1/openapi.jsonEspecificación completa de la API

En preparación (todavía no disponibles):

GET/api/v1/membersLista miembros de tu community — en preparación
GET/api/v1/eventsLista eventos programados — en preparación
GET/api/v1/subscriptionsSubscripciones activas — en preparación
GET/api/v1/analyticsMétricas (MRR, churn, signups) — en preparación
GET/api/v1/exportExport completo — mientras tanto te lo entregamos a pedido: hi@faroli.io

4. Webhooks (en preparación)

Faroli podrá notificar a tu backend cuando sucedan eventos en tu community. Este es el diseño previsto — los webhooks salientes aún no están activos.

  • 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 llevará X-Faroli-Signature con HMAC-SHA256 del payload. Valídalo 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 — avísanos: 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, puedes usar cualquier cliente (fetch, axios, requests, curl).