メタデータ、カスタムURL、公開

できること

これら4つのエンドポイントで、フリップブックの見せ方を制御できます。タイトルとSEOメタデータ、公開状態、共有URL、そして読書体験の見た目です。各エンドポイントは{flipbookId}で1つのフリップブックを対象にします。

• タイトルとSEOメタを設定する — Title、Description、TitleColor、IsPublishedフラグ。
• タイトルや説明に触れずに公開・非公開を切り替える。
• 共有URL用にカスタム（分かりやすい）スラッグを付ける。
• ビューアーのページ表示を設定する — ページの厚みとカバーの種類。

始める前に

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

タイトルとSEOメタを設定する

PUT /api/set-meta/{flipbookId}は、フリップブックのタイトルとSEOメタ（Title、Description、TitleColor、IsPublishedフラグ）を設定します。これはTitle／Description／TitleColorを上書きします。公開状態だけを変更したい場合は、代わりにset-published（下記）を使ってください。TitleColorは先頭に#を付けた16進の色（例: #1a1a1a、デフォルトは#000000）を取り、そのまま保存されます。

curl -X PUT 'https://go.fliplink.me/api/set-meta/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Title=Spring 2026 Catalog' \
  --data-urlencode 'Description=Our latest product lineup and pricing' \
  --data-urlencode 'IsPublished=true'

レスポンス:

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

公開・非公開を切り替える

PUT /api/set-published/{flipbookId}は公開フラグだけを切り替え、Title／Description／TitleColorはそのまま残します（set-metaとは異なります）。フリップブックを（再）公開するのに使います。たとえば、create-by-fileから非公開の状態で戻ってきたものなどです。IsPublishedは必須で、true/1 = 公開、false/0 = 非公開です。

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

レスポンス:

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

カスタムURLを設定する

PUT /api/set-custom-url/{flipbookId}は、CustomURLフィールドで、フリップブックの共有URL用のカスタム（分かりやすい）スラッグを設定します。スラッグは一意である必要があります。すでに使われているスラッグはResult: "ERROR"を返します（下記のエラーを参照）。

curl -X PUT 'https://go.fliplink.me/api/set-custom-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'CustomURL=spring-catalog'

レスポンス:

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

ページ表示を設定する

PUT /api/set-page-appearance/{flipbookId}は、ビューアーのページ表示を設定します。このエンドポイントで現在設定できるフィールドは2つだけです。PageDepth（flat、thin、thickを受け付けます）とCoverType（softまたはhardを受け付けます）です。値はそのまま保存されます。古いアイテムでは、Get oneで読み戻したときに他の値（例: regularや数値の1）が返ることがあります。

curl -X PUT 'https://go.fliplink.me/api/set-page-appearance/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PageDepth=thin' \
  --data-urlencode 'CoverType=soft'

レスポンス:

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

起こりうるエラー

これらのエラーは4つのエンドポイントに共通します（custom-URLには独自のものが1つ加わります）。

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

目安として、Result: "OK"は変更が適用されたこと、Result: "ERROR"は適用されなかったことを意味します。理由はMessageを読んでください。

メモ

• set-meta と set-published: set-metaはTitle／Description／TitleColorを上書きします。公開状態だけを変更したい場合は、set-publishedを使ってください。これらのフィールドはそのまま残ります。