Personalizzare il brand di un flipbook (logo, favicon, skin, sfondo)

Cosa puoi fare

Cinque endpoint di scrittura ti permettono di personalizzare il brand del viewer ospitato di un flipbook senza toccare la dashboard. Ognuno agisce su un singolo flipbook (tramite il suo {flipbookId}) e cambia un aspetto del suo aspetto:

• Impostare il logo mostrato nell'area header/branding del viewer.
• Impostare la favicon (l'icona della scheda del browser) della pagina del viewer ospitato.
• Applicare una skin/un tema al viewer.
• Impostare l'immagine di sfondo del viewer.
• Impostare il testo di caricamento personalizzato mostrato nella schermata di caricamento 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 che vuoi personalizzare. Viene restituito da create-by-file / create-by-url (come ID) o da list. Tutti e cinque gli endpoint lo accettano 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 il logo

Imposta l'immagine del logo mostrata nell'area header/branding del viewer del flipbook.

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'

Questo endpoint accetta tre campi nel body:

• LogoIMG — l'immagine del logo stessa (il suo URL/percorso). È l'immagine mostrata nell'area header/branding del viewer.
• LogoURL — il link di destinazione a cui punta il logo; cliccando il logo si apre questo URL. Predefinito https://fliplink.me.
• IsShowLogoMobile — un boolean (true / false, predefinito false) che stabilisce se il logo viene mostrato su mobile.

Risposta:

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

Impostare la favicon

Imposta la favicon (l'icona della scheda del browser) usata dalla pagina del viewer ospitato del flipbook.

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

Risposta:

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

Applicare una skin

Applica una skin/un tema del viewer al flipbook; il server risolve il nome della skin nel suo ID. Il campo è SkinName (la stringa da list-skins), non un ID numerico.

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

Risposta:

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

Impostare l'immagine di sfondo

Imposta l'immagine di sfondo del viewer da un URL che fornisci tu (non c'è una galleria integrata). BackgroundIMG accetta l'URL di un'immagine, o un URL placeholder come https://plchldr.co/i/100x100?text=&bg=HEX. Qualsiasi valore di colore è una stringa esadecimale #RRGGBB e viene memorizzato così com'è.

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

Risposta:

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

Impostare il testo di caricamento

Imposta il testo personalizzato mostrato nella schermata di caricamento del viewer. Il campo è CustomLoadingText, non LoadingText.

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

Risposta:

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

Errori possibili

Questi valgono per tutti e cinque gli endpoint:

• 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: …".

Note

• Per Set Skin, invia il Name della skin (da /api/list-skins) in SkinName — non un ID numerico.
• Per Set Loading Text, il campo è CustomLoadingText; inviare LoadingText verrà rifiutato come campo sconosciuto.
• Per Set Background Image, non c'è una galleria integrata — fornisci tu stesso l'URL dell'immagine.