De viewer- en leeservaring configureren

Wat je kunt doen

Deze vijf endpoints configureren hoe één flipbook zich in de viewer presenteert. Elk richt zich op één flipbook via zijn {flipbookId} en werkt één aspect van de kijk- en leeservaring bij:

• Toon of verberg afzonderlijke werkbalkknoppen van de viewer (downloaden, printen, delen, volledig scherm, zoomen, thumbnails, enz.).
• Configureer de lezersnavigatie — paginathumbnails, inhoudsopgave en hoe lezers zich tussen pagina's bewegen.
• Schakel automatisch pagina's omslaan in of uit en stel het interval in.
• Stel de achtergrondmuziektrack in of wis die die in de viewer speelt.
• Stel de inhoud in die in de vier hoeken (header/footer) van de viewer-chrome wordt getoond.

Voordat je begint

• Een API-sleutel, meegestuurd op elk verzoek als de X-Api-Key-header of als Authorization: Bearer YOUR_API_KEY.
• De {flipbookId} — de numerieke ID van de flipbook, teruggegeven door create-by-file / create-by-url (als ID) of door list. Elk endpoint hier neemt hem als padparameter.
• Alle verzoeken gaan naar de basis-URL https://go.fliplink.me.
• Elke request-body hier is form-urlencoded (geen JSON). Stuur elk veld met --data-urlencode.

De viewer-bediening instellen

Toont of verbergt afzonderlijke werkbalkknoppen van de viewer (downloaden, printen, delen, volledig scherm, zoomen, thumbnails, enz.).

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'

Response:

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

De lezersnavigatie instellen

Configureert de lezersnavigatie in de viewer — hoe lezers zich tussen pagina's bewegen. De vier body-velden:

• BookLayout (getal) — een numerieke pagina-indeling. De API slaat op wat je meestuurt.
• ScrollBehaviour (getal) — een numerieke scrollmodus; standaard is 1. De betekenis van elke waarde wordt aan de kijkerskant geïnterpreteerd, en de API slaat op wat je meestuurt.
• IsNavFirstLast (boolean, true/false) — schakelt de navigatie naar de eerste/laatste pagina.
• IsRightToLeft (boolean, true/false) — stelt lezen van rechts naar links in.

Let op: deze lezersnavigatie-instellingen gelden alleen voor flipbooks. Op een Document-item worden ze genegeerd — de API antwoordt 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'

Response:

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

Automatisch omslaan instellen

Schakelt het automatisch omslaan van pagina's in de viewer in of uit en stelt het interval in. De waarde AutoFlipInSecs is ondanks de naam in milliseconden: 0 = uit, 3000 = 3s, 5000 = 5s, enz.

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

Response:

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

Achtergrondmuziek instellen

Stelt de achtergrondmuziektrack die in de viewer speelt in of wist die. Gebruik een vooraf gedefinieerde tracknaam uit /api/list-background-music in BackgroundMusic, of een eigen geüploade muziek-URL 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'

Response:

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

De header/footer-indeling instellen

Stelt de inhoud in die in de vier hoeken (header/footer) van de viewer-chrome wordt getoond: TopLeft, TopRight, BottomLeft en 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='

Response:

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

Mogelijke fouten

Alle vijf de endpoints hebben hetzelfde foutgedrag:

• Ontbrekende of ongeldige API-sleutel → HTTP 401. Dit geeft een kale Unauthorized-HTML-pagina terug — er is geen JSON-body. Controleer of de X-Api-Key-header (of Authorization: Bearer) aanwezig en correct is.
• Item-ID niet gevonden of niet in eigendom van je sleutel → HTTP 200 met Message "Item not found".
• Onbekend of verkeerd gespeld body-veld → HTTP 200 met Message "Unknown field(s) '…'. Expected: …".

Een Result van "OK" betekent dat de wijziging is doorgevoerd; anders lees je het Message-veld voor de reden.