Primeros pasos con la CLI de FlipLink

Si vives en la terminal, hacer clic por un panel para publicar un flipbook se siente como un rodeo. La CLI de FlipLink te deja hacer todo el proceso — crear, publicar y compartir — sin salir de tu shell. Es una capa ligera y programable sobre la API de FlipLink, así que todo lo que puedes hacer con una petición HTTP, lo puedes hacer con un solo comando.

Esta guía te lleva de cero a un flipbook publicado y listo para compartir en unos cinco minutos. Al final tendrás la CLI instalada, autenticada y generando una URL pública directamente desde un PDF.

Instala la CLI

La CLI se distribuye como un paquete npm y necesita Node.js 18 o más reciente. Instálala de forma global para que el comando fliplink esté disponible en todas partes:

npm install -g fliplink-cli

¿Prefieres no instalar nada de forma permanente? Puedes ejecutar cualquier comando cuando lo necesites con npx:

npx fliplink-cli whoami

En ambos casos tienes disponible el mismo conjunto de comandos. El resto de esta guía asume una instalación global.

Configura tu clave de API

Cada comando se autentica con tu clave de API de FlipLink. Consigue una iniciando sesión en https://go.fliplink.me y abriendo la página de Subscription.

Guarda la clave una sola vez y la CLI la recuerda:

fliplink config set-key YOUR_API_KEY

Esto escribe la clave en ~/.config/fliplink/config.json con permisos 600, de modo que solo tu usuario puede leerla. Para CI/CD o scripts donde prefieres no escribir un archivo de configuración, define una variable de entorno en su lugar:

export FLIPLINK_API_KEY=YOUR_API_KEY

La CLI resuelve las credenciales en este orden: primero la variable de entorno FLIPLINK_API_KEY y luego el archivo de configuración. Trata la clave como una contraseña — nunca la subas a un repositorio. Si quieres conocer a fondo cómo funciona esta autenticación basada en cabeceras, la entrada del glosario de la API es un buen punto de partida.

Confirma que estás conectado

Antes de hacer cualquier otra cosa, ejecuta una comprobación rápida. whoami llama al endpoint de identidad de la cuenta y confirma que tu clave funciona:

fliplink whoami

Una respuesta correcta imprime los datos de tu cuenta (y tu tamaño máximo de subida). Si ves un error de autenticación, tu clave falta o es incorrecta — vuelve a ejecutar config set-key e inténtalo de nuevo. Esta es la misma primera llamada que recomendamos para la propia API, así que es una prueba de humo fiable.

Crea un flipbook a partir de un PDF

Ahora viene lo divertido. Apunta la CLI a un PDF local y dale un título:

fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3

--title es lo que ven los lectores y --name es una etiqueta interna que usarás para encontrarlo más tarde. El comando sube el archivo, inicia la conversión y devuelve el ID del nuevo flipbook. Anota ese ID — lo usarás en los dos pasos siguientes.

¿Ya tienes el PDF alojado en algún sitio? Sáltate la subida y créalo a partir de una URL:

fliplink flipbook create-url https://example.com/deck.pdf --title "Q3 Report"

🚀

Prueba FlipLink Gratis

Convierte tu PDF en segundos. Sin registro, sin tarjeta de crédito — solo súbelo y listo.

Drop your PDF here or click to browse

Máximo 40MB

Los planes de pago desde $39 lo amplían a 150 MB.

Publica y comparte

Un flipbook recién creado no es público hasta que lo publicas. Aquí está la secuencia completa — crear, publicar y luego obtener el enlace para compartir — usando el ID que devuelve cada paso:

# 1. Create from a PDF and note the returned ID
fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3

# 2. Publish it (use the ID from step 1)
fliplink flipbook publish 90001

# 3. Get the public share link
fliplink flipbook share-link 90001

publish pone el flipbook en línea; share-link devuelve la URL que entregas a los lectores. ¿Cambiaste de opinión? fliplink flipbook unpublish 90001 lo retira sin eliminar nada.

Salida legible por máquina con --json

De forma predeterminada, la CLI imprime una salida fácil de leer para personas. Añade --json a cualquier comando para obtener la respuesta JSON en bruto — ideal para canalizarla a jq o capturar un valor en un script:

fliplink flipbook create ./deck.pdf --title "Q3 Report" --json | jq -r '.ID'

Ese comando de una línea crea un flipbook e imprime únicamente su ID, listo para alimentar el siguiente comando. Esta es la base de cualquier automatización que vayas a construir — consulta Automatización e integraciones para ver hasta dónde llega.

Códigos de salida para scripts

La CLI usa códigos de salida predecibles para que tus scripts puedan ramificarse según el éxito o el fallo sin analizar la salida:

Esa separación importa: un 2 significa que tu petición llegó a FlipLink pero fue rechazada por un motivo de negocio (entrada no válida, cuota superada), mientras que un 1 significa que la petición en sí falló. En un script de shell puedes reaccionar en consecuencia:

fliplink flipbook publish 90001 || echo "Publish failed with exit code $?"

Adónde ir después

Ya tienes el ciclo básico: instalar, autenticar, crear, publicar, compartir. A partir de aquí puedes integrar la CLI en cualquier cosa que ejecute comandos.

• Referencia completa de comandos — cada flag y subcomando está en la documentación de la CLI.
• Automatízalo — ejecuta la misma secuencia en un horario o por cada commit. Nuestra guía para automatizar la publicación de flipbooks en CI/CD recorre un pipeline real.
• ¿Necesitas todo el poder de la API en bruto? — la CLI envuelve la referencia de la API, y el atajo fliplink api alcanza cualquier endpoint que los comandos con nombre aún no cubran.

Una vez que publicas tu primer flipbook desde la terminal, el panel empieza a parecer opcional — que es justo de lo que se trata.

Lecturas relacionadas

• Documentación de la CLI de FlipLink — la referencia completa de comandos
• CLI vs API vs MCP: ¿cuál deberías usar?
• Automatiza la publicación de flipbooks en CI/CD
• Cómo usar la API de FlipLink para integraciones personalizadas
• Automatización e integraciones
• ¿Qué es una API? (glosario)