カバー画像とプレビュー画像

ブランディングとコンテンツ

リード獲得や支払いの前に読者が見るプレビューPDFと、サムネイルやプレビューに使う画像のみのPDFを、APIで設定できます。

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

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

できること

2つの書き込みエンドポイントで、読者がフルアクセスを得る前にフリップブックの代わりに表示されるPDFを制御できます。

リード獲得／支払いの前に読者に表示されるプレビューPDFを設定する。
サムネイルやプレビューに使う画像PDFを設定する。

各呼び出しは{flipbookId}で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ではありません）を取ります。

プレビューPDFを設定する

PUT /api/set-preview-pdf/{flipbookId}は、リード獲得／支払いの前に読者に表示されるプレビューPDFを設定します。リード獲得と販売モードの両方がオフの場合は、自動的にクリアされます。

使用するPDFのURLをPreviewPDFとして送ります。

PreviewPDF — プレビューとして表示するPDFのURLです。値はそのまま保存され、APIはURLに到達できるかを検証しません（実機で確認済み）。有効で到達可能なPDF URLを送ってください。デフォルトは空（プレビューPDFなし）です。

curl -X PUT 'https://go.fliplink.me/api/set-preview-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'PreviewPDF=https://go.fliplink.me/files/preview.pdf'

レスポンス:

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

画像PDFを設定する

PUT /api/set-image-pdf/{flipbookId}は、サムネイルやプレビューに使う画像のみ／プレビュー用のPDFを設定します。使用するPDFのURLをIMGPdfとして送ります。

IMGPdf — サムネイルやプレビューに使う画像のみのPDFのURLです。値はそのまま保存され、APIはURLに到達できるかを検証しません（実機で確認済み）。有効で到達可能なPDF URLを送ってください。デフォルトは画像なしのプレースホルダーで、空の値を送ると既存の画像PDFが保たれます。

curl -X PUT 'https://go.fliplink.me/api/set-image-pdf/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IMGPdf=https://go.fliplink.me/files/pages.pdf'