Hoe installeer ik de FlipLink CLI?

Voer npm install -g fliplink-cli uit (vereist Node.js 18+), of gebruik de tool zonder te installeren via npx fliplink-cli whoami.

Hoe authenticeer ik in CI?

Geef je sleutel mee als de omgevingsvariabele FLIPLINK_API_KEY — bijvoorbeeld FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Die wordt nooit naar schijf weggeschreven. Lokaal kun je hem eenmalig opslaan met fliplink config set-key.

Wat is de API-escape hatch?

Elk endpoint dat nog niet in een handig commando is verpakt, bereik je rechtstreeks met fliplink api , zodat de CLI vanaf dag één de volledige REST API dekt.

Kan ik de CLI scripten?

Ja. Elk commando print standaard een tabel en met --json ruwe JSON (pipe die naar jq). De exitcodes zijn scriptbaar: 0 geslaagd, 1 request-/HTTP-fout, 2 applicatiefout (Result: ERROR).

Hoeveel commando's zijn er?

87 commando's verdeeld over 9 groepen (flipbook, profile, account, folder, cname, team, leads, sales, lookup), gegenereerd uit dezelfde API-spec als de REST API, zodat de CLI niet kan afwijken van de gedocumenteerde endpoints.

Opdrachtregel-interface

FlipLink CLI

Maak, configureer, publiceer en beheer je flipbooks vanuit de terminal of CI — een dunne, scriptbare wrapper rond de FlipLink REST-API.

Aan de slag Bekijk de REST-API

Installeert via npm · 87 commando's · JSON-uitvoer om mee te scripten

Installeren

terminal

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

Vereist Node.js 18 of nieuwer.

Authenticeren

Haal een API-sleutel op uit je FlipLink-dashboard → Abonnement en bewaar hem dan:

setup

fliplink config set-key YOUR_API_KEY
fliplink whoami

Of geef hem per aanroep mee (handig in CI — wordt nooit naar schijf geschreven):

FLIPLINK_API_KEY=YOUR_API_KEY fliplink flipbook list

Volgorde van resolutie voor elke instelling: omgevingsvariabele → configuratiebestand → ingebouwde standaard. De opgeslagen sleutel staat in ~/.config/fliplink/config.json met chmod 600-rechten.

Veelgebruikte commando's

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

Voer fliplink <command> --help uit voor de vlaggen van een commando.

Alle commandogroepen

Elk endpoint is bereikbaar als een benoemd commando. Voer fliplink <group> --help uit om de commando's van een groep op te sommen.

Groep	Omvat
flipbook	maken / lezen / wijzigen / verwijderen + alle instellingen per flipbook (skin, CTA's, leadgeneratie, toegang, delen, verkoop, tracking, …)
profile	get, set
account	abonnement, betalingen
folder	list
cname	add, list, delete (eigen domeinen)
team	list, get, set, set-active, delete
leads	list, delete, delete-bulk
sales	list
lookup	templates, skins, valuta, achtergrondmuziek

Google Sheets-endpoints gebruiken een andere basis-URL en zijn alleen bereikbaar via de api-noodingang.

Scripting

Elk commando print standaard een leesbare tabel en met --json ruwe JSON:

terminal

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

Afsluitcodes: 0 succes · 1 verzoek-/HTTP-fout · 2 applicatiefout (Result: ERROR).

Shell-aanvulling

Genereer een aanvullingsscript voor je shell:

terminal

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

Noodingang — elk endpoint, vandaag al

Elk endpoint dat nog niet in een handig commando is verpakt, is rechtstreeks bereikbaar:

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

Blader door elk endpoint, de bijbehorende parameters en responses in de volledige REST API-referentie.

Hoe het werkt

Het commando-oppervlak wordt gegenereerd uit de API-specificatie — dezelfde endpoints.json die de REST-API-documentatie aandrijft — zodat de CLI niet kan afwijken van de gedocumenteerde API. Liever natuurlijke taal? Dezelfde API is ook beschikbaar als MCP-server voor AI-assistenten.

Veelgestelde vragen

Hoe installeer ik de FlipLink CLI?: Voer npm install -g fliplink-cli uit (vereist Node.js 18+), of gebruik de tool zonder te installeren via npx fliplink-cli whoami.
Hoe authenticeer ik in CI?: Geef je sleutel mee als de omgevingsvariabele FLIPLINK_API_KEY — bijvoorbeeld FLIPLINK_API_KEY=YOUR_KEY fliplink flipbook list. Die wordt nooit naar schijf weggeschreven. Lokaal kun je hem eenmalig opslaan met fliplink config set-key.
Wat is de API-escape hatch?: Elk endpoint dat nog niet in een handig commando is verpakt, bereik je rechtstreeks met fliplink api <METHOD> <path>, zodat de CLI vanaf dag één de volledige REST API dekt.
Kan ik de CLI scripten?: Ja. Elk commando print standaard een tabel en met --json ruwe JSON (pipe die naar jq). De exitcodes zijn scriptbaar: 0 geslaagd, 1 request-/HTTP-fout, 2 applicatiefout (Result: ERROR).
Hoeveel commando's zijn er?: 87 commando's verdeeld over 9 groepen (flipbook, profile, account, folder, cname, team, leads, sales, lookup), gegenereerd uit dezelfde API-spec als de REST API, zodat de CLI niet kan afwijken van de gedocumenteerde endpoints.

Blijf bouwen

REST API-referentieDe volledige endpointreferentie waar de CLI omheen is gebouwd.MCP-serverBedien FlipLink vanuit een AI-assistent in natuurlijke taal.Automatisering & integratiesKoppel FlipLink aan je stack — webhooks, Zapier, Sheets.Aan de slag met de CLIInstalleer, log in en publiceer je eerste flipbook vanuit de terminal.