FlipLink

カバーページ、リンクの有効期限、ピン留め

フリップブック

表紙・裏表紙のカバーページを追加・削除し、フリップブックの自動有効期限を設定・解除し、ピン留めの状態を切り替えられます。すべてAPIで行います。

このディスカッションで使うAPI

このガイドに誤りや古い情報がありますか？

できること

これら5つのエンドポイントで、フリップブックのカバーページ、リンクの有効期限、ピン留めの有無を、ダッシュボードに触れることなく管理できます。

  • アップロードしたPDFファイルから、表紙・裏表紙のカバーページを追加する。
  • リモートのPDF URLから、表紙・裏表紙のカバーページを追加する。
  • 表紙・裏表紙のラップを削除し、フリップブックをラップされていないコアPDFに戻す。
  • フリップブックの自動有効期限を設定・解除する。
  • フリップブックをピン留め・解除して、ダッシュボードの先頭に並べる。

始める前に

  • APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
  • ここでの各エンドポイントは{flipbookId}パスパラメーター（create-by-file／create-by-urlが返す（IDとして）、または一覧が返すフリップブックの数値ID）を取ります。以下の例では96216を使います。
  • すべてのリクエストの送信先はベースURL https://go.fliplink.meです。
  • URL版のカバーページとset-expiryのエンドポイントは、form-urlencodedのボディ（JSONではありません）を送ります。ファイル版のカバーページのエンドポイントは、multipart form-data（ファイルアップロード）を送ります。clearとpinのエンドポイントは、ボディを取りません。

ファイルから表紙・裏表紙のカバーページを設定する

アップロードしたPDFファイルから、表紙・裏表紙のページを追加します。Front/Backのいずれか、または両方が任意ですが、少なくとも1つは必須です。ページは既存のメインPDFに再マージされます。

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  -F 'Front=@/path/to/file' \
  -F 'Back=@/path/to/file'

レスポンス:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

URLから表紙・裏表紙のカバーページを設定する

上のURL版です。アップロードしたファイルではなく、リモートのPDF URLから表紙・裏表紙のページを追加します。FrontとBackのフィールドはform-urlencodedで送ります。

curl -X PUT 'https://go.fliplink.me/api/set-front-back-page-by-url/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Front=https://example.com/front.pdf' \
  --data-urlencode 'Back=https://example.com/back.pdf'

レスポンス:

{
  "Result": "OK",
  "Message": "Pages attached successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

表紙・裏表紙のカバーページを削除する

表紙・裏表紙のラップを削除し、FilePDFをラップされていないコアPDF（MiddlePDF）に戻します。これはべき等です。ラップのないフリップブックはOKを返し、何も変更しません。レスポンスには、復元されたコアPDFのS3 URLが含まれます。古いマージ済み／表紙／裏表紙のS3オブジェクトは削除されません。ボディは取りません。

curl -X PUT 'https://go.fliplink.me/api/clear-front-back-page/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

レスポンス:

{
  "Result": "OK",
  "Message": "Pages updated successfully",
  "URL": "https://<bucket>.s3.us-east-1.amazonaws.com/docs/<vendor>/<hash>~main.pdf"
}

有効期限を設定・解除する

フリップブックの自動有効期限を設定または解除します。DaysとHoursは整数で送ります。Hoursは任意で、デフォルトは0です。Days=-1, Hours=0を送ると、有効期限が完全に解除されます。

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=7' \
  --data-urlencode 'Hours=12'

レスポンス:

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

有効期限を解除するには、Days=-1を送ります。

curl -X PUT 'https://go.fliplink.me/api/set-expiry/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'Days=-1' \
  --data-urlencode 'Hours=0'

ピン留め・解除する

フリップブックをピン留め・解除（スター付きの状態）して、ダッシュボードの先頭に並べます。これはトグルで、ボディは取りません。

curl -X PUT 'https://go.fliplink.me/api/set-pin/96216' \
  -H 'X-Api-Key: YOUR_API_KEY'

レスポンス:

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

起こりうるエラー

  • APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありません。X-Api-Keyヘッダーが存在し、正しいことを確認してください。
  • 不明なflipbookId（またはキーが所有していないもの） → HTTP 200で"Message": "Item not found"。
  • 表紙・裏表紙の設定（ファイル）— 無効なPDF → アップロードしたファイルが読み取り可能なPDFでない場合、HTTP 200で"Message": "File is not a valid PDF."。
  • 表紙・裏表紙の設定（ファイル）— ファイルが大きすぎる → アップロードがプランの最大ファイルサイズを超えた場合、HTTP 413で"Message": "File exceeds the maximum allowed upload size."。
  • 表紙・裏表紙の設定（URL）と有効期限の設定 — 不明なフィールド → ボディフィールドのスペルミスや認識できないものがある場合、HTTP 200で"Message": "Unknown field(s) '…'. Expected: …"。

関連ディスカッション

フリップブックを作成する（PDFまたはURLから）フリップブックを削除するフリップブックとその詳細を取得するフォルダとテンプレートでフリップブックを整理するフリップブックのPDFを差し替える・複製する