¿Cómo instalo la CLI de FlipLink?

Ejecuta npm install -g fliplink-cli (requiere Node.js 18+) o úsala sin instalar nada con npx fliplink-cli whoami.

¿Cómo me autentico en CI?

Pasa tu clave como variable de entorno FLIPLINK_API_KEY; por ejemplo, FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Nunca se escribe en disco. De forma local puedes guardarla una vez con fliplink config set-key.

¿Qué es la vía de escape de la API?

Cualquier endpoint que aún no esté envuelto en un comando práctico es accesible directamente con fliplink api , así que la CLI cubre toda la API REST desde el primer día.

¿Puedo automatizar la CLI con scripts?

Sí. Cada comando imprime una tabla de forma predeterminada y JSON sin procesar con --json (canalízalo a jq). Los códigos de salida son aptos para scripts: 0 éxito, 1 error de petición/HTTP, 2 error de aplicación (Result: ERROR).

¿Cuántos comandos hay?

87 comandos repartidos en 9 grupos (flipbook, profile, account, folder, cname, team, leads, sales, lookup), generados a partir de la misma especificación de API que la API REST, de modo que la CLI no puede desviarse de los endpoints documentados.

Interfaz de línea de comandos

CLI de FlipLink

Crea, configura, publica y gestiona tus flipbooks desde la terminal o el CI: un wrapper ligero y programable sobre la API REST de FlipLink.

Comenzar Ver la API REST

Se instala con npm · 87 comandos · salida en JSON para scripts

Instalación

terminal

npm install -g fliplink-cli
# or run without installing:
npx fliplink-cli whoami

Requiere Node.js 18 o una versión más reciente.

Autenticación

Consigue una clave de API en tu panel de FlipLink → Suscripción y luego guárdala:

configuración

fliplink config set-key YOUR_API_KEY
fliplink whoami

O pásala en cada invocación (práctico en CI, nunca se escribe en disco):

FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook list

Orden de resolución para cada ajuste: variable de entorno → archivo de configuración → valor predeterminado. La clave guardada vive en ~/.config/fliplink/config.json con permisos chmod 600.

Comandos comunes

terminal

fliplink flipbook create ./deck.pdf --title "Q3 Report" --name q3
fliplink flipbook create-url https://example.com/deck.pdf --title "Q3 Report"
fliplink flipbook list --search report --page-size 25 --sort-by CreatedOn
fliplink flipbook get <flipbookId>
fliplink flipbook publish <flipbookId>
fliplink flipbook unpublish <flipbookId>
fliplink flipbook set-expiry <flipbookId> --days 30
fliplink flipbook share-link <flipbookId>
fliplink flipbook delete <flipbookId>
fliplink leads list --item <flipbookId> --download true

Ejecuta fliplink <command> --help para ver las opciones de cualquier comando.

Todos los grupos de comandos

Cada endpoint está disponible como un comando con nombre. Ejecuta fliplink <group> --help para listar los comandos de un grupo.

Grupo	Cubre
flipbook	crear / leer / modificar / eliminar + todos los ajustes por flipbook (skin, CTA, captación de leads, acceso, compartición, ventas, seguimiento, …)
profile	get, set
account	suscripción, pagos
folder	list
cname	add, list, delete (dominios personalizados)
team	list, get, set, set-active, delete
leads	list, delete, delete-bulk
sales	list
lookup	plantillas, skins, monedas, música de fondo

Los endpoints de Google Sheets usan una URL base distinta y solo están disponibles mediante la vía de escape api.

Scripting

Cada comando imprime una tabla legible por defecto y JSON sin formato con --json:

terminal

fliplink flipbook list --json | jq '.[].ID'

Códigos de salida: 0 éxito · 1 error de petición/HTTP · 2 error de aplicación (Result: ERROR).

Autocompletado del shell

Genera un script de autocompletado para tu shell:

terminal

source <(fliplink completion zsh)    # add to ~/.zshrc
source <(fliplink completion bash)   # add to ~/.bashrc

Vía de escape: cada endpoint, hoy mismo

Cualquier endpoint que aún no tenga un comando amigable está disponible directamente:

terminal

fliplink api GET  /api/list-folders
fliplink api PUT  /api/set-skin/<flipbookId> --data '{"SkinName":"Modern"}'
fliplink api POST /api/create-by-file --file File=./deck.pdf -q Name=deck

Explora cada endpoint, sus parámetros y respuestas en la referencia completa de la API REST.

Cómo funciona

La superficie de comandos se genera a partir de la especificación de la API —el mismo endpoints.json que alimenta la documentación de la API REST—, así que la CLI no puede desviarse de la API documentada. ¿Prefieres el lenguaje natural? La misma API también está disponible como servidor MCP para asistentes de IA.

Preguntas frecuentes

¿Cómo instalo la CLI de FlipLink?: Ejecuta npm install -g fliplink-cli (requiere Node.js 18+) o úsala sin instalar nada con npx fliplink-cli whoami.
¿Cómo me autentico en CI?: Pasa tu clave como variable de entorno FLIPLINK_API_KEY; por ejemplo, FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Nunca se escribe en disco. De forma local puedes guardarla una vez con fliplink config set-key.
¿Qué es la vía de escape de la API?: Cualquier endpoint que aún no esté envuelto en un comando práctico es accesible directamente con fliplink api <METHOD> <path>, así que la CLI cubre toda la API REST desde el primer día.
¿Puedo automatizar la CLI con scripts?: Sí. Cada comando imprime una tabla de forma predeterminada y JSON sin procesar con --json (canalízalo a jq). Los códigos de salida son aptos para scripts: 0 éxito, 1 error de petición/HTTP, 2 error de aplicación (Result: ERROR).
¿Cuántos comandos hay?: 87 comandos repartidos en 9 grupos (flipbook, profile, account, folder, cname, team, leads, sales, lookup), generados a partir de la misma especificación de API que la API REST, de modo que la CLI no puede desviarse de los endpoints documentados.

Sigue construyendo

Referencia de la API RESTLa referencia completa de endpoints que la CLI envuelve.Servidor MCPManeja FlipLink desde un asistente de IA con lenguaje natural.Automatización e integracionesConecta FlipLink con tu stack: webhooks, Zapier, Sheets.Primeros pasos con la CLIInstala, inicia sesión y publica tu primer flipbook desde la terminal.