フォルダとテンプレートでフリップブックを整理する

できること

これら3つのエンドポイントで、ダッシュボードに触れることなくフリップブックを整理しておけます。

• フォルダを一覧表示する。各フォルダは名前とフォルダGUIDとして返されます。
• フリップブックをフォルダに割り当てる — フォルダは必要に応じて作成され、空のフォルダを送るとフリップブックがフォルダから外れます。
• フリップブックを再利用できるテンプレートとして保存する、またはテンプレートから外す。

始める前に

• APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
• すべてのリクエストの送信先はベースURL https://go.fliplink.meです。
• 2つの書き込みエンドポイント（assign-to-folderとsave-as-template）は、{flipbookId}パスパラメーター（create-by-file／create-by-urlが返す（IDとして）、または一覧が返すフリップブックの数値ID）を使います。
• これらの書き込みエンドポイントは、form-urlencodedのボディ（JSONではありません）を取ります。

フォルダを一覧表示する

GET /api/list-foldersは、フォルダを{ Folder（名前）, URL（フォルダGUID） }として一覧表示します。フォルダはフリップブックの割り当てから導かれるため、空のフォルダは一覧に表示されません。

curl -X GET 'https://go.fliplink.me/api/list-folders' \
  -H 'X-Api-Key: YOUR_API_KEY'

レスポンス:

{
  "Result": "OK",
  "Items": [
    {
      "Folder": "Marketing",
      "URL": "00000000-0000-0000-0000-000000000001"
    },
    {
      "Folder": "Marketing/Q2",
      "URL": "00000000-0000-0000-0000-000000000002"
    }
  ]
}

フリップブックをフォルダに割り当てる

PUT /api/assign-to-folder/{flipbookId}は、フリップブックをフォルダに移動します。フォルダは必要に応じて作成されます。まだ存在しないフォルダ名に割り当てると、自動的に作成されます（別途「フォルダ作成」の呼び出しはありません）。フォルダ名には/を含められます（例: Marketing/Q2）。フォルダは、少なくとも1つのフリップブックが入っている間だけ存在します。最後のフリップブックを外すと、そのフォルダはlist-foldersから消えます。

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder=Marketing/Q2'

レスポンス:

{
  "Result": "OK",
  "Message": "Folder updated successfully"
}

フリップブックをフォルダから外すには、空のFolderを送ります。

curl -X PUT 'https://go.fliplink.me/api/assign-to-folder/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Folder='

フリップブックをテンプレートとして保存する

PUT /api/save-as-template/{flipbookId}は、フリップブックを再利用できるテンプレートとして登録（Status=true）するか、テンプレートから外します（Status=false）。テンプレートはlist-templatesに表示され、新しいフリップブックの元にできます。Statusは省略するとtrueがデフォルトになります。

curl -X PUT 'https://go.fliplink.me/api/save-as-template/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Status=true'

レスポンス:

{
  "Result": "OK",
  "Message": "Saved as template"
}

起こりうるエラー

• APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。
• アイテムIDが見つからないか、キーが所有していない場合（assign-to-folder、save-as-template） → HTTP 200でMessage: "Item not found"。
• 不明またはスペルミスのボディフィールド（assign-to-folder、save-as-template） → HTTP 200でMessage: "Unknown field(s) '…'. Expected: …"。

メモ

• 割り当てるFolder名は、list-foldersのFolderに表示される値と同じです。そのため、既存のフォルダ名を再利用して、そこにフリップブックを追加できます。