Guía de inicio rápido
Empieza a trabajar con la API de ZenFlip en menos de cinco minutos. Crea tu primera clave API, autentícate y lista tus publicaciones.
Guía de inicio rápido
Esta guía te acompaña en la obtención de credenciales, la autenticación con la API de ZenFlip y la realización de tu primera solicitud exitosa. Al final, habrás listado todas las publicaciones de tu organización.
URL base
Todas las solicitudes a la API se realizan a la URL base versionada:
Cada endpoint documentado en esta guía es relativo a esa URL base. Por ejemplo, el endpoint de login se resuelve como https://api.zenflip.io/v1/auth/login.
Paso 1 --- Obtén tu clave API
ZenFlip soporta dos métodos de autenticación: tokens JWT (para aplicaciones orientadas al usuario) y claves API (para integraciones servidor a servidor).
Para crear una clave API:
Inicia sesión en el panel de control de ZenFlip en
https://app.zenflip.io.Navega a Settings > API Keys.
Haz clic en Generate New Key, dale una etiqueta descriptiva (ej., "Production Backend") y copia la clave inmediatamente. No se mostrará de nuevo.
Las claves API están vinculadas a tu organización. Las solicitudes realizadas con una clave API heredan los permisos del propietario de la organización.
Paso 2 --- Autentícate
Opción A: Clave API (servidor a servidor)
Pasa tu clave API en la cabecera Authorization con el prefijo Bearer:
Opción B: Token JWT (sesiones de usuario)
Obtén un token de acceso JWT de corta duración llamando al endpoint de login:
Una respuesta exitosa devuelve un token de acceso y un token de actualización:
Usa el accessToken en las solicitudes posteriores:
Paso 3 --- Haz tu primera llamada a la API
Lista todas las publicaciones de tu organización con una simple solicitud GET:
La respuesta sigue el formato paginado estándar:
Formato de respuesta
Todas las respuestas exitosas envuelven los datos en una clave data. Los endpoints paginados incluyen un objeto meta con detalles de paginación.
Respuestas de error
Cuando una solicitud falla, la API devuelve una estructura de error consistente:
Código de estado | Significado |
| Bad Request --- entrada no válida |
| Unauthorized --- token faltante o incorrecto |
| Forbidden --- permisos insuficientes |
| Not Found --- el recurso no existe |
| Too Many Requests --- límite de tasa alcanzado |
| Internal Server Error |
Límites de tasa
La API aplica límites de tasa por minuto basados en tu plan:
Plan | Límite de tasa |
Explorer | 100 req/min |
Creator | 100 req/min |
Business | 100 req/min |
Enterprise | 1.000 req/min |
Cuando excedes el límite, la API devuelve un estado 429 con una cabecera Retry-After que indica cuántos segundos esperar.
Próximos pasos
Autenticación --- Inmersión profunda en tokens JWT, flujos de actualización y Google OAuth.
API de publicaciones --- Crea, actualiza y gestiona tus flipbooks.
Widget de incrustación --- Añade flipbooks interactivos a cualquier sitio web.