Configurar a experiência do visualizador e do leitor

O que você pode fazer

Estes cinco endpoints configuram como um único flipbook se apresenta no visualizador. Cada um atua sobre um flipbook pelo seu {flipbookId} e atualiza um aspecto da experiência de visualização e leitura:

• Mostrar ou ocultar botões individuais da barra de ferramentas do visualizador (download, impressão, compartilhamento, tela cheia, zoom, miniaturas, etc.).
• Configurar a navegação do leitor — miniaturas de páginas, sumário e como os leitores se movem entre as páginas.
• Ativar ou desativar a virada automática de páginas e definir o intervalo dela.
• Definir ou remover a faixa de música de fundo que toca no visualizador.
• Definir o conteúdo exibido nos quatro cantos (cabeçalho/rodapé) da moldura 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, retornado por create-by-file / create-by-url (como ID) ou por list. Todo endpoint aqui o recebe 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 os controles do visualizador

Mostra ou oculta botões individuais da barra de ferramentas do visualizador (download, impressão, compartilhamento, tela cheia, zoom, miniaturas, etc.).

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'

Resposta:

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

Defina a navegação do leitor

Configura a navegação do leitor no visualizador — como os leitores se movem entre as páginas. Os quatro campos do corpo:

• BookLayout (número) — um layout de página numérico. A API armazena qualquer valor que você enviar.
• ScrollBehaviour (número) — um modo de rolagem numérico; o padrão é 1. O significado de cada valor é interpretado no lado do visualizador, e a API armazena qualquer valor que você enviar.
• IsNavFirstLast (boolean, true/false) — ativa a navegação de primeira/última página.
• IsRightToLeft (boolean, true/false) — define a leitura da direita para a esquerda.

Observação: essas configurações de navegação do leitor se aplicam somente a flipbooks. Em um item Document elas são ignoradas — a API responde 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'

Resposta:

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

Defina a virada automática

Ativa ou desativa a virada automática de páginas no visualizador e o intervalo dela. O valor de AutoFlipInSecs é em milissegundos apesar do nome: 0 = desativado, 3000 = 3s, 5000 = 5s, etc.

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

Resposta:

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

Defina a música de fundo

Define ou remove a faixa de música de fundo que toca no visualizador. Use um nome de arquivo de faixa predefinida de /api/list-background-music em BackgroundMusic, ou uma URL de música personalizada enviada em 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'

Resposta:

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

Defina o layout de cabeçalho/rodapé

Define o conteúdo exibido nos quatro cantos (cabeçalho/rodapé) da moldura do visualizador: TopLeft, TopRight, BottomLeft e 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='

Resposta:

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

Erros possíveis

Todos os cinco endpoints compartilham o mesmo comportamento de erro:

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

Um Result de "OK" significa que a mudança foi aplicada; caso contrário, leia a Message para saber o motivo.