ビューアーとリーダー体験を設定する

できること

これら5つのエンドポイントで、1つのフリップブックがビューアーでどう見えるかを設定できます。各エンドポイントは{flipbookId}で1つのフリップブックを対象にし、閲覧・読書体験の1つの側面を更新します。

• 個別のビューアーツールバーのボタン（ダウンロード、印刷、共有、全画面、ズーム、サムネイルなど）を表示・非表示にする。
• リーダーのナビゲーションを設定する — ページのサムネイル、目次、読者がページ間をどう移動するか。
• 自動ページめくりを有効・無効にし、その間隔を設定する。
• ビューアーで再生される背景音楽のトラックを設定・解除する。
• ビューアーのクロームの四隅（ヘッダー／フッター）に表示されるコンテンツを設定する。

始める前に

• APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
• {flipbookId} — フリップブックの数値IDで、create-by-file／create-by-url（IDとして）や一覧から返されます。ここでの各エンドポイントは、これをパスパラメーターとして取ります。
• すべてのリクエストの送信先はベースURL https://go.fliplink.meです。
• ここでの各リクエストボディはform-urlencoded（JSONではありません）です。各フィールドは--data-urlencodeで送ってください。

ビューアーのコントロールを設定する

個別のビューアーツールバーのボタン（ダウンロード、印刷、共有、全画面、ズーム、サムネイルなど）を表示・非表示にします。

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'

レスポンス:

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

リーダーのナビゲーションを設定する

ビューアーのリーダーのナビゲーション（読者がページ間をどう移動するか）を設定します。4つのボディフィールドは次のとおりです。

• BookLayout（数値） — 数値のページレイアウトです。APIは送った値をそのまま保存します。
• ScrollBehaviour（数値） — 数値のスクロールモードで、デフォルトは1です。各値の意味はビューアー側で解釈され、APIは送った値をそのまま保存します。
• IsNavFirstLast（ブール、true/false） — 最初／最後のページへのナビゲーションを切り替えます。
• IsRightToLeft（ブール、true/false） — 右から左への読書方向を設定します。

注意: これらのリーダーナビゲーションの設定は、フリップブックのみに適用されます。Documentアイテムでは無視され、APIは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'

レスポンス:

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

自動ページめくりを設定する

ビューアーの自動ページめくりとその間隔を有効・無効にします。AutoFlipInSecsの値は、名前に反してミリ秒単位です。0 = オフ、3000 = 3秒、5000 = 5秒、などです。

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

レスポンス:

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

背景音楽を設定する

ビューアーで再生される背景音楽のトラックを設定・解除します。/api/list-background-musicの定義済みトラックのファイル名をBackgroundMusicに、またはカスタムでアップロードした音楽のURLを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'

レスポンス:

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

ヘッダー／フッターのレイアウトを設定する

ビューアーのクロームの四隅（ヘッダー／フッター）に表示されるコンテンツ（TopLeft、TopRight、BottomLeft、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='

レスポンス:

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

起こりうるエラー

5つのエンドポイントは、いずれも同じエラー動作をします。

• APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。X-Api-Keyヘッダー（またはAuthorization: Bearer）が存在し、正しいことを確認してください。
• アイテムIDが見つからないか、キーが所有していない場合 → HTTP 200でMessageは"Item not found"。
• 不明またはスペルミスのボディフィールド → HTTP 200でMessageは"Unknown field(s) '…'. Expected: …"。

Resultが"OK"なら変更が適用されたことを意味します。そうでない場合は、理由をMessageで読んでください。