Configurare l'esperienza del viewer e del reader

Cosa puoi fare

Questi cinque endpoint configurano come un singolo flipbook si presenta nel viewer. Ognuno agisce su un flipbook tramite il suo {flipbookId} e aggiorna un aspetto dell'esperienza di visualizzazione e lettura:

• Mostrare o nascondere i singoli pulsanti della barra degli strumenti del viewer (download, stampa, condivisione, schermo intero, zoom, miniature, ecc.).
• Configurare la navigazione del reader — miniature delle pagine, indice e come i lettori si spostano tra le pagine.
• Attivare o disattivare il giro pagina automatico e impostarne l'intervallo.
• Impostare o rimuovere la traccia di musica di sottofondo che suona nel viewer.
• Impostare il contenuto mostrato nei quattro angoli (header/footer) della cornice del viewer.

Prima di iniziare

• Una chiave API, inviata come header X-Api-Key o come Authorization: Bearer YOUR_API_KEY in ogni richiesta.
• Il {flipbookId} — l'ID numerico del flipbook, restituito da create-by-file / create-by-url (come ID) o da list. Ogni endpoint qui lo accetta come parametro nel percorso.
• Tutte le richieste vanno all'URL di base https://go.fliplink.me.
• Ogni body di richiesta qui è form-urlencoded (non JSON). Invia ogni campo con --data-urlencode.

Impostare i controlli del viewer

Mostra o nasconde i singoli pulsanti della barra degli strumenti del viewer (download, stampa, condivisione, schermo intero, zoom, miniature, ecc.).

curl -X PUT 'https://go.fliplink.me/api/set-viewer-controls/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShowControls=true' \
  --data-urlencode 'IsPrint=false' \
  --data-urlencode 'IsDownload=false' \
  --data-urlencode 'IsThumbnails=true' \
  --data-urlencode 'IsSearch=true' \
  --data-urlencode 'IsSound=true' \
  --data-urlencode 'IsFullscreen=true' \
  --data-urlencode 'IsZoom=true' \
  --data-urlencode 'IsNotes=false'

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Impostare la navigazione del reader

Configura la navigazione del reader nel viewer — come i lettori si spostano tra le pagine. I quattro campi del body:

• BookLayout (numero) — un layout di pagina numerico. L'API memorizza qualsiasi valore invii.
• ScrollBehaviour (numero) — una modalità di scorrimento numerica; il predefinito è 1. Il significato di ogni valore è interpretato lato viewer, e l'API memorizza qualsiasi valore invii.
• IsNavFirstLast (boolean, true/false) — attiva/disattiva la navigazione prima/ultima pagina.
• IsRightToLeft (boolean, true/false) — imposta la lettura da destra a sinistra.

Nota: queste impostazioni di navigazione del reader si applicano solo ai flipbook. Su un elemento Document vengono ignorate — l'API risponde This setting applies to Flipbook items only.

curl -X PUT 'https://go.fliplink.me/api/set-reader-navigation/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsNavFirstLast=true' \
  --data-urlencode 'BookLayout=1' \
  --data-urlencode 'IsRightToLeft=false' \
  --data-urlencode 'ScrollBehaviour=1'

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Impostare il giro pagina automatico

Attiva o disattiva il giro pagina automatico nel viewer e il suo intervallo. Il valore AutoFlipInSecs è in millisecondi nonostante il nome: 0 = disattivato, 3000 = 3s, 5000 = 5s, ecc.

curl -X PUT 'https://go.fliplink.me/api/set-auto-flip/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AutoFlipInSecs=0'

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Impostare la musica di sottofondo

Imposta o rimuove la traccia di musica di sottofondo che suona nel viewer. Usa il nome file di una traccia predefinita da /api/list-background-music in BackgroundMusic, oppure l'URL di una musica personalizzata caricata in BackgroundMusicCustom.

curl -X PUT 'https://go.fliplink.me/api/set-background-music/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundMusic=' \
  --data-urlencode 'BackgroundMusicCustom=' \
  --data-urlencode 'IsBackgroundMusicLoop=false'

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Impostare il layout di header/footer

Imposta il contenuto mostrato nei quattro angoli (header/footer) della cornice del viewer: TopLeft, TopRight, BottomLeft e BottomRight.

curl -X PUT 'https://go.fliplink.me/api/set-header-footer-layout/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'TopLeft=' \
  --data-urlencode 'TopRight=' \
  --data-urlencode 'BottomLeft=' \
  --data-urlencode 'BottomRight='

Risposta:

{
  "Result": "OK",
  "Message": "Updated successfully"
}

Errori possibili

Tutti e cinque gli endpoint condividono lo stesso comportamento in caso di errore:

• Chiave API mancante o non valida → HTTP 401. Restituisce una semplice pagina HTML di Unauthorized — non c'è alcun body JSON. Controlla che l'header X-Api-Key (o Authorization: Bearer) sia presente e corretto.
• ID dell'elemento non trovato o non di proprietà della tua chiave → HTTP 200 con Message "Item not found".
• Campo del body sconosciuto o scritto male → HTTP 200 con Message "Unknown field(s) '…'. Expected: …".

Un Result di "OK" significa che la modifica è stata applicata; altrimenti leggi il Message per capirne il motivo.