リファレンスの検索（テンプレート、スキン、通貨、音楽）

できること

4つの読み取り専用エンドポイントが、フリップブックを設定するときに参照するリファレンスのリストを返します。各エンドポイントは特定の設定に対する有効な選択肢を一覧表示するので、リストからIDや名前を選んで、対応する書き込みエンドポイントに渡せます。

• テンプレートを一覧表示する — アカウントに保存された再利用可能なフリップブックのテンプレート。
• スキンを一覧表示する — 利用可能なビューアーのスキン／テーマ。それぞれに付属の背景URLがあります。
• 通貨を一覧表示する — フリップブックを販売するときに利用できる通貨。
• 背景音楽を一覧表示する — フリップブックのビューアーに付けられる組み込みの背景音楽トラック。

始める前に

• APIキーで認証します。X-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
• ベースURL: https://go.fliplink.me。
• これらはリクエストボディもパスパラメーターもないGETの検索です。記載のある箇所では、オプションをクエリ文字列として渡します。

テンプレートを一覧表示する

アカウントに保存された再利用可能なフリップブックのテンプレートを一覧表示します。DocTypeで絞り込みます。テンプレートのIDを、save-as-templateや作成のフローで使います。

curl -X GET 'https://go.fliplink.me/api/list-templates?DocType=0' \
  -H 'X-Api-Key: YOUR_API_KEY'

レスポンス:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "- Blank Template - "
    }
  ]
}

DocTypeクエリパラメーターは、0 = Flipbook（デフォルト）または1 = Documentを受け付けます。

スキンを一覧表示する

利用可能なビューアーのスキン／テーマを一覧表示します。各行にはスキンの付属背景URLが含まれます。スキンのNameをset-skinで使います。

curl -X GET 'https://go.fliplink.me/api/list-skins?Type=false' \
  -H 'X-Api-Key: YOUR_API_KEY'

レスポンス:

{
  "Result": "OK",
  "Items": [
    {
      "ID": -1,
      "Name": "Light Wood",
      "ImageURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/1.webp",
      "ThumbURL": "https://af203091.s3.us-east-1.amazonaws.com/docs/background/thumb/1.webp"
    }
  ]
}

Typeクエリパラメーターはブール値です。false = Flipbookのスキン、true = Documentのスキン。

通貨を一覧表示する

フリップブックを販売するときに利用できる通貨（販売／チェックアウトの設定用）を一覧表示します。

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

レスポンス:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "AED"
    }
  ]
}

背景音楽を一覧表示する

フリップブックのビューアーに付けられる組み込みの背景音楽トラックを一覧表示します。

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

レスポンス:

{
  "Result": "OK",
  "Items": [
    {
      "Name": "None",
      "FileURL": ""
    }
  ]
}

起こりうるエラー

• APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。これは4つのエンドポイントすべてに当てはまります。