Een flipbook branden (logo, favicon, skin, achtergrond)

Wat je kunt doen

Met vijf schrijf-endpoints brand je de gehoste viewer van een flipbook zonder het dashboard aan te raken. Elk endpoint richt zich op één flipbook (via zijn {flipbookId}) en wijzigt één aspect van de weergave:

• Stel het logo in dat in het header-/brandinggebied van de viewer wordt getoond.
• Stel de favicon in (het browsertabblad-icoon) van de gehoste viewerpagina.
• Pas een skin/thema toe op de viewer.
• Stel de achtergrondafbeelding in van de viewer.
• Stel de aangepaste laadtekst in die op het laadscherm van de viewer 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 die je wilt branden. Die wordt teruggegeven door create-by-file / create-by-url (als ID) of door list. Alle vijf de endpoints nemen 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.

Het logo instellen

Stelt de logo-afbeelding in die in het header-/brandinggebied van de flipbookviewer wordt getoond.

curl -X PUT 'https://go.fliplink.me/api/set-logo/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LogoIMG=' \
  --data-urlencode 'LogoURL=' \
  --data-urlencode 'IsShowLogoMobile=false'

Dit endpoint accepteert drie body-velden:

• LogoIMG — de logo-afbeelding zelf (de URL/het pad ervan). Dit is de afbeelding die in het header-/brandinggebied van de viewer wordt getoond.
• LogoURL — de doorklik-link waar het logo naar verwijst; wanneer je op het logo klikt, opent deze URL. Standaard https://fliplink.me.
• IsShowLogoMobile — een boolean (true / false, standaard false) die bepaalt of het logo op mobiel wordt getoond.

Response:

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

De favicon instellen

Stelt de favicon in (het browsertabblad-icoon) die door de gehoste viewerpagina van de flipbook wordt gebruikt.

curl -X PUT 'https://go.fliplink.me/api/set-favicon/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FaviconIMG='

Response:

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

Een skin toepassen

Past een viewerskin/-thema toe op de flipbook; de server zet de skinnaam om naar de bijbehorende ID. Het veld is SkinName (de string uit list-skins), geen numerieke ID.

curl -X PUT 'https://go.fliplink.me/api/set-skin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'SkinName='

Response:

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

De achtergrondafbeelding instellen

Stelt de achtergrondafbeelding van de viewer in vanaf een URL die je opgeeft (er is geen ingebouwde galerij). BackgroundIMG neemt een afbeeldings-URL, of een placeholder-URL zoals https://plchldr.co/i/100x100?text=&bg=HEX. Elke kleurwaarde is een hex-#RRGGBB-string en wordt opgeslagen zoals hij is.

curl -X PUT 'https://go.fliplink.me/api/set-background-image/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'BackgroundIMG='

Response:

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

De laadtekst instellen

Stelt de aangepaste tekst in die op het laadscherm van de viewer wordt getoond. Het veld is CustomLoadingText, niet LoadingText.

curl -X PUT 'https://go.fliplink.me/api/set-loading-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomLoadingText='

Response:

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

Mogelijke fouten

Deze gelden voor alle vijf de endpoints:

• 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- (of Authorization: Bearer-)header 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: …".

Opmerkingen

• Voor Set Skin stuur je de Name van de skin (uit /api/list-skins) in SkinName — geen numerieke ID.
• Voor Set Loading Text is het veld CustomLoadingText; het meesturen van LoadingText wordt geweigerd als onbekend veld.
• Voor Set Background Image is er geen ingebouwde galerij — je geeft de afbeeldings-URL zelf op.