Personalizar la marca de un flipbook (logo, favicon, skin, fondo)

Qué puedes hacer

Cinco endpoints de escritura te permiten aplicar tu marca al visor alojado de un flipbook sin tocar el panel. Cada uno apunta a un solo flipbook (por su {flipbookId}) y cambia un aspecto de su apariencia:

• Define el logo que se muestra en la zona de encabezado/marca del visor.
• Define el favicon (el icono de la pestaña del navegador) de la página del visor alojado.
• Aplica un skin/tema al visor.
• Define la imagen de fondo del visor.
• Define el texto de carga personalizado que aparece en la pantalla de carga del visor.

Antes de empezar

• Una clave de API, enviada en cada petición como el encabezado X-Api-Key o como Authorization: Bearer YOUR_API_KEY.
• El {flipbookId}: el ID numérico del flipbook al que quieres aplicar tu marca. Lo devuelven create-by-file / create-by-url (como ID) o list. Los cinco endpoints lo reciben como parámetro de ruta.
• Todas las peticiones van a la URL base https://go.fliplink.me.
• Cada cuerpo de petición aquí es form-urlencoded (no JSON). Envía cada campo con --data-urlencode.

Define el logo

Define la imagen del logo que se muestra en la zona de encabezado/marca del visor 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'

Este endpoint acepta tres campos en el cuerpo:

• LogoIMG: la imagen del logo en sí (su URL/ruta). Es la imagen que se muestra en la zona de encabezado/marca del visor.
• LogoURL: el enlace de destino al que apunta el logo; al hacer clic en el logo se abre esta URL. Por defecto es https://fliplink.me.
• IsShowLogoMobile: un booleano (true / false, por defecto false) que controla si el logo se muestra en móvil.

Respuesta:

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

Define el favicon

Define el favicon (el icono de la pestaña del navegador) que usa la página del visor alojado del flipbook.

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

Respuesta:

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

Aplica un skin

Aplica un skin/tema del visor al flipbook; el servidor resuelve el nombre del skin a su ID. El campo es SkinName (la cadena que devuelve list-skins), no un ID numérico.

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

Respuesta:

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

Define la imagen de fondo

Define la imagen de fondo del visor a partir de una URL que tú proporcionas (no hay galería integrada). BackgroundIMG recibe la URL de una imagen, o una URL de marcador como https://plchldr.co/i/100x100?text=&bg=HEX. Cualquier valor de color es una cadena hex #RRGGBB y se guarda tal cual.

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

Respuesta:

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

Define el texto de carga

Define el texto personalizado que se muestra en la pantalla de carga del visor. El campo es CustomLoadingText, no LoadingText.

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

Respuesta:

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

Errores posibles

Se aplican a los cinco endpoints:

• Clave de API ausente o no válida → HTTP 401. Devuelve una página HTML de "Unauthorized" sin formato — no hay cuerpo JSON. Comprueba que el encabezado X-Api-Key (o Authorization: Bearer) esté presente y sea correcto.
• ID del ítem no encontrado o no perteneciente a tu clave → HTTP 200 con Message: "Item not found".
• Campo del cuerpo desconocido o mal escrito → HTTP 200 con Message: "Unknown field(s) '…'. Expected: …".

Notas

• Para Set Skin, envía el Name del skin (de /api/list-skins) en SkinName, no un ID numérico.
• Para Set Loading Text, el campo es CustomLoadingText; enviar LoadingText se rechazará como un campo desconocido.
• Para Set Background Image no hay galería integrada: la URL de la imagen la proporcionas tú.