Come installo la CLI di FlipLink?

Esegui npm install -g fliplink-cli (richiede Node.js 18+), oppure usala senza installarla con npx fliplink-cli whoami.

Come mi autentico in CI?

Passa la tua chiave come variabile d'ambiente FLIPLINK_API_KEY — per esempio FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Non viene mai scritta su disco. In locale puoi salvarla una volta sola con fliplink config set-key.

Cos'è l'escape hatch dell'API?

Qualsiasi endpoint non ancora avvolto in un comando dedicato è raggiungibile direttamente con fliplink api , così la CLI copre l'intera API REST fin dal primo giorno.

Posso usare la CLI negli script?

Sì. Ogni comando stampa una tabella per impostazione predefinita e il JSON grezzo con --json (passalo in pipe a jq). I codici di uscita sono scriptabili: 0 successo, 1 errore di richiesta/HTTP, 2 errore dell'applicazione (Result: ERROR).

Quanti comandi ci sono?

87 comandi in 9 gruppi (flipbook, profile, account, folder, cname, team, leads, sales, lookup), generati dalla stessa specifica API della API REST, così la CLI non può divergere dagli endpoint documentati.

Interfaccia a riga di comando

CLI di FlipLink

Crea, configura, pubblica e gestisci i tuoi flipbook dal terminale o dalla CI — un wrapper scriptabile e leggero sull'API REST di FlipLink.

Inizia ora Vedi l'API REST

Si installa con npm · 87 comandi · output in JSON per lo scripting

Installazione

terminale

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

Richiede Node.js 18 o versioni successive.

Autenticazione

Ottieni una chiave API dalla tua dashboard di FlipLink → Abbonamento, poi salvala:

configurazione

fliplink config set-key YOUR_API_KEY
fliplink whoami

Oppure passala a ogni esecuzione (comodo in CI — non viene mai scritta su disco):

FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook list

Ordine di risoluzione per ogni impostazione: variabile d'ambiente → file di configurazione → valore predefinito integrato. La chiave salvata risiede in ~/.config/fliplink/config.json con permessi chmod 600.

Comandi comuni

terminale

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

Esegui fliplink <command> --help per i flag di qualsiasi comando.

Tutti i gruppi di comandi

Ogni endpoint è raggiungibile come comando dedicato. Esegui fliplink <group> --help per elencare i comandi di un gruppo.

Gruppo	Copre
flipbook	crea / leggi / modifica / elimina + tutte le impostazioni per ogni flipbook (skin, CTA, acquisizione contatti, accessi, condivisione, vendite, tracciamento, …)
profile	get, set
account	abbonamento, pagamenti
folder	list
cname	add, list, delete (domini personalizzati)
team	list, get, set, set-active, delete
leads	list, delete, delete-bulk
sales	list
lookup	template, skin, valute, musica di sottofondo

Gli endpoint di Google Sheets usano un URL di base diverso e sono raggiungibili solo tramite l'escape hatch api.

Scripting

Ogni comando stampa per impostazione predefinita una tabella leggibile e il JSON grezzo con --json:

terminale

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

Codici di uscita: 0 successo · 1 errore di richiesta/HTTP · 2 errore dell'applicazione (Result: ERROR).

Completamento della shell

Genera uno script di completamento per la tua shell:

terminale

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

Escape hatch — ogni endpoint, da subito

Qualsiasi endpoint non ancora avvolto in un comando dedicato è raggiungibile direttamente:

terminale

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

Esplora tutti gli endpoint, i parametri e le risposte nel riferimento completo dell'API REST.

Come funziona

L'insieme dei comandi è generato dalla specifica dell'API — lo stesso endpoints.json che alimenta la documentazione dell'API REST — così la CLI non può discostarsi dall'API documentata. Preferisci il linguaggio naturale? La stessa API è disponibile anche come server MCP per gli assistenti AI.

Domande frequenti

Come installo la CLI di FlipLink?: Esegui npm install -g fliplink-cli (richiede Node.js 18+), oppure usala senza installarla con npx fliplink-cli whoami.
Come mi autentico in CI?: Passa la tua chiave come variabile d'ambiente FLIPLINK_API_KEY — per esempio FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Non viene mai scritta su disco. In locale puoi salvarla una volta sola con fliplink config set-key.
Cos'è l'escape hatch dell'API?: Qualsiasi endpoint non ancora avvolto in un comando dedicato è raggiungibile direttamente con fliplink api <METHOD> <path>, così la CLI copre l'intera API REST fin dal primo giorno.
Posso usare la CLI negli script?: Sì. Ogni comando stampa una tabella per impostazione predefinita e il JSON grezzo con --json (passalo in pipe a jq). I codici di uscita sono scriptabili: 0 successo, 1 errore di richiesta/HTTP, 2 errore dell'applicazione (Result: ERROR).
Quanti comandi ci sono?: 87 comandi in 9 gruppi (flipbook, profile, account, folder, cname, team, leads, sales, lookup), generati dalla stessa specifica API della API REST, così la CLI non può divergere dagli endpoint documentati.

Continua a sviluppare

Riferimento API RESTIl riferimento completo degli endpoint che la CLI avvolge.Server MCPGestisci FlipLink da un assistente AI in linguaggio naturale.Automazione e integrazioniCollega FlipLink al tuo stack — webhook, Zapier, Sheets.Primi passi con la CLIInstalla, autenticati e pubblica il tuo primo flipbook dal terminale.