Aplicar sua marca a um flipbook (logo, favicon, skin, fundo)

O que você pode fazer

Cinco endpoints de escrita permitem aplicar sua marca ao visualizador hospedado de um flipbook sem tocar no painel. Cada um atua sobre um único flipbook (pelo seu {flipbookId}) e muda um aspecto da aparência dele:

• Definir o logo exibido na área de cabeçalho/marca do visualizador.
• Definir o favicon (ícone da aba do navegador) da página do visualizador hospedado.
• Aplicar uma skin/tema ao visualizador.
• Definir a imagem de fundo do visualizador.
• Definir o texto personalizado de carregamento exibido na tela de carregamento do visualizador.

Antes de começar

• Uma chave de API — enviada como cabeçalho X-Api-Key ou como Authorization: Bearer YOUR_API_KEY em toda requisição.
• O {flipbookId} — o ID numérico do flipbook ao qual você quer aplicar a marca. Ele é retornado por create-by-file / create-by-url (como ID) ou por list. Todos os cinco endpoints o recebem como parâmetro de caminho.
• Todas as requisições vão para a URL base https://go.fliplink.me.
• Todo corpo de requisição aqui é form-urlencoded (não JSON). Envie cada campo com --data-urlencode.

Defina o logo

Define a imagem de logo exibida na área de cabeçalho/marca do visualizador do 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 aceita três campos de corpo:

• LogoIMG — a imagem do logo em si (sua URL/caminho). É a imagem exibida na área de cabeçalho/marca do visualizador.
• LogoURL — o link de clique para o qual o logo aponta; clicar no logo abre essa URL. O padrão é https://fliplink.me.
• IsShowLogoMobile — um boolean (true / false, padrão false) que define se o logo é exibido no celular.

Resposta:

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

Defina o favicon

Define o favicon (ícone da aba do navegador) usado pela página do visualizador hospedado do flipbook.

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

Resposta:

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

Aplique uma skin

Aplica uma skin/tema de visualizador ao flipbook; o servidor resolve o nome da skin para o ID dela. O campo é SkinName (a string vinda de list-skins), não um ID numérico.

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

Resposta:

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

Defina a imagem de fundo

Define a imagem de fundo do visualizador a partir de uma URL que você fornece (não há galeria embutida). BackgroundIMG recebe uma URL de imagem, ou uma URL de placeholder como https://plchldr.co/i/100x100?text=&bg=HEX. Qualquer valor de cor é uma string hexadecimal #RRGGBB e é armazenado como está.

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

Resposta:

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

Defina o texto de carregamento

Define o texto personalizado exibido na tela de carregamento do visualizador. O campo é CustomLoadingText, não LoadingText.

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

Resposta:

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

Erros possíveis

Estes se aplicam aos cinco endpoints:

• Chave de API ausente ou inválida → HTTP 401. Isso retorna uma página HTML de Unauthorized simples — não há corpo JSON. Confira se o cabeçalho X-Api-Key (ou Authorization: Bearer) está presente e correto.
• ID do item não encontrado ou não pertencente à sua chave → HTTP 200 com Message: "Item not found".
• Campo do corpo desconhecido ou digitado errado → HTTP 200 com Message: "Unknown field(s) '…'. Expected: …".

Notas

• Para o Set Skin, envie o Name da skin (de /api/list-skins) em SkinName — não um ID numérico.
• Para o Set Loading Text, o campo é CustomLoadingText; enviar LoadingText será rejeitado como campo desconhecido.
• Para o Set Background Image, não há galeria embutida — você fornece a URL da imagem.