Comment installer la CLI FlipLink ?

Lance npm install -g fliplink-cli (nécessite Node.js 18+), ou utilise-la sans installation via npx fliplink-cli whoami.

Comment s'authentifier en CI ?

Passe ta clé dans la variable d'environnement FLIPLINK_API_KEY — par exemple FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Elle n'est jamais écrite sur le disque. En local, tu peux l'enregistrer une fois pour toutes avec fliplink config set-key.

Qu'est-ce que l'échappatoire API ?

Tout endpoint qui n'est pas encore encapsulé dans une commande conviviale reste accessible directement avec fliplink api , si bien que la CLI couvre l'intégralité de l'API REST dès le premier jour.

Puis-je scripter la CLI ?

Oui. Chaque commande affiche un tableau par défaut et du JSON brut avec --json (que tu peux passer à jq). Les codes de sortie sont scriptables : 0 succès, 1 erreur de requête/HTTP, 2 erreur applicative (Result: ERROR).

Combien y a-t-il de commandes ?

87 commandes réparties en 9 groupes (flipbook, profile, account, folder, cname, team, leads, sales, lookup), générées à partir de la même spécification d'API que l'API REST, pour que la CLI ne puisse pas s'écarter des endpoints documentés.

Interface en ligne de commande

CLI FlipLink

Crée, configure, publie et gère tes flipbooks depuis le terminal ou la CI — un wrapper léger et scriptable autour de l'API REST FlipLink.

Commencer Voir l'API REST

S'installe via npm · 87 commandes · sortie JSON pour le scripting

Installation

terminal

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

Nécessite Node.js 18 ou une version plus récente.

Authentification

Récupère une clé API depuis ton tableau de bord FlipLink → Abonnement, puis enregistre-la :

configuration

fliplink config set-key YOUR_API_KEY
fliplink whoami

Ou passe-la à chaque appel (pratique en CI — jamais écrite sur le disque) :

FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook list

Ordre de résolution de chaque paramètre : variable d'environnement → fichier de config → valeur par défaut intégrée. La clé enregistrée se trouve dans ~/.config/fliplink/config.json avec les permissions chmod 600.

Commandes courantes

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

Lance fliplink <command> --help pour voir les options de n'importe quelle commande.

Tous les groupes de commandes

Chaque endpoint est accessible via une commande nommée. Lance fliplink <group> --help pour lister les commandes d'un groupe.

Groupe	Couvre
flipbook	création / lecture / modification / suppression + tous les réglages par flipbook (skin, CTA, capture de prospects, accès, partage, ventes, suivi, …)
profile	get, set
account	abonnement, paiements
folder	list
cname	add, list, delete (domaines personnalisés)
team	list, get, set, set-active, delete
leads	list, delete, delete-bulk
sales	list
lookup	modèles, skins, devises, musique de fond

Les endpoints Google Sheets utilisent une autre URL de base et ne sont accessibles que via l'échappatoire api.

Scripting

Chaque commande affiche un tableau lisible par défaut, et du JSON brut avec --json :

terminal

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

Codes de sortie : 0 succès · 1 erreur de requête/HTTP · 2 erreur applicative (Result: ERROR).

Complétion du shell

Génère un script de complétion pour ton shell :

terminal

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

Échappatoire — chaque endpoint, dès aujourd'hui

Tout endpoint pas encore encapsulé dans une commande conviviale reste accessible directement :

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

Parcours chaque endpoint, ses paramètres et ses réponses dans la référence complète de l’API REST.

Comment ça marche

La surface de commandes est générée à partir de la spécification de l'API — le même endpoints.json qui alimente la doc de l'API REST — donc le CLI ne peut pas s'écarter de l'API documentée. Tu préfères le langage naturel ? La même API est aussi disponible en tant que serveur MCP pour les assistants IA.

Questions fréquentes

Comment installer la CLI FlipLink ?: Lance npm install -g fliplink-cli (nécessite Node.js 18+), ou utilise-la sans installation via npx fliplink-cli whoami.
Comment s'authentifier en CI ?: Passe ta clé dans la variable d'environnement FLIPLINK_API_KEY — par exemple FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Elle n'est jamais écrite sur le disque. En local, tu peux l'enregistrer une fois pour toutes avec fliplink config set-key.
Qu'est-ce que l'échappatoire API ?: Tout endpoint qui n'est pas encore encapsulé dans une commande conviviale reste accessible directement avec fliplink api <METHOD> <path>, si bien que la CLI couvre l'intégralité de l'API REST dès le premier jour.
Puis-je scripter la CLI ?: Oui. Chaque commande affiche un tableau par défaut et du JSON brut avec --json (que tu peux passer à jq). Les codes de sortie sont scriptables : 0 succès, 1 erreur de requête/HTTP, 2 erreur applicative (Result: ERROR).
Combien y a-t-il de commandes ?: 87 commandes réparties en 9 groupes (flipbook, profile, account, folder, cname, team, leads, sales, lookup), générées à partir de la même spécification d'API que l'API REST, pour que la CLI ne puisse pas s'écarter des endpoints documentés.

Continue à créer

Référence de l'API RESTLa référence complète des endpoints que la CLI encapsule.Serveur MCPPilote FlipLink depuis un assistant IA, en langage naturel.Automatisation et intégrationsConnecte FlipLink à ta stack — webhooks, Zapier, Sheets.Premiers pas avec la CLIInstalle, authentifie-toi et publie ton premier flipbook depuis le terminal.