フリップブックのPDFを差し替える・複製する
フリップブック既存のフリップブックの中身のPDFを、ファイルアップロードまたはURLから差し替え、IDと共有リンクを保ったまま入れ替え、任意のフリップブックのサーバー側コピーを作成できます。
このディスカッションで使うAPI
このガイドに誤りや古い情報がありますか?
できること
これらのエンドポイントで、すでに作成したフリップブックの中身のPDFを変更したり、コピーを作成したりできます。すべてサーバー側で行われ、ゼロから作り直す必要はありません。
- ファイルからPDFを差し替える — multipart form dataで新しいPDFをアップロードする。
- URLからPDFを差し替える — サーバーにURLを渡すと、新しいPDFをダウンロードします。
- フリップブックを複製する — 1つ以上のコピーを作成し、それぞれに新しい
IDと共有URLが付きます。
どちらの差し替え方法でも、フリップブックのID、設定、共有リンクは保たれます。変わるのは中身のPDFだけです。
始める前に
- APIキー — すべてのリクエストで
X-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。 - ベースURL:
https://go.fliplink.me。 - 3つのエンドポイントはいずれも
{flipbookId}パスパラメーター(create-by-file/create-by-urlが返す(IDとして)、または一覧が返すフリップブックの数値ID)を取ります。 - PDFの差し替え(URL)と複製は、ボディをform-urlencoded(JSONではありません)として送ります。PDFの差し替え(ファイル)はmultipart form dataを送ります。
ファイルからPDFを差し替える
multipartアップロードです。サーバーは、フリップブックにまだ付いている既存の表紙・裏表紙のページと、新しいPDFを自動的に再マージします。フリップブックのID、設定、共有リンクは保たれます。
curl -X PUT 'https://go.fliplink.me/api/replace-pdf/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
-F 'File=@/path/to/file'
レスポンス:
{
"Result": "OK",
"Message": "Updated successfully"
}
URLからPDFを差し替える
指定したURLからサーバーがダウンロードするPDFで、既存のフリップブックのPDFを差し替えます。フリップブックのID、設定、共有リンクは保たれます。
curl -X PUT 'https://go.fliplink.me/api/replace-pdf-by-url/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'File=https://example.com/new.pdf'
レスポンス:
{
"Result": "OK",
"Message": "Updated successfully"
}
フリップブックを複製する
フリップブックのサーバー側コピーを1つ以上作成します。各コピーには、それぞれ新しいIDと共有URLが付きます。Countは1〜500を受け付け、サーバー側でその範囲に収められます。
curl -X POST 'https://go.fliplink.me/api/duplicate/96216' \
-H 'X-Api-Key: YOUR_API_KEY' \
--data-urlencode 'Count=3'
レスポンス:
{
"Result": "OK",
"Count": 3,
"Items": [
{
"ID": "93213",
"URL": "https://go.fliplink.me/C73371B4-B041-4EBD-A518-1E5B5B56DA44"
},
{
"ID": "93214",
"URL": "https://go.fliplink.me/2F9A0C7D-6E51-4B22-A9F0-7D3C1E8B4A15"
},
{
"ID": "93215",
"URL": "https://go.fliplink.me/8B4E2A19-C037-45D6-9E1B-4A6F0D2C7E83"
}
]
}
起こりうるエラー
PDFの差し替え(ファイル) — PUT /api/replace-pdf/{flipbookId}:
- APIキーが欠けているか無効な場合 → HTTP
401。401 Unauthorized HTMLページを返し、JSONボディはありません。 - アイテムIDが見つからないか、キーが所有していない場合 → HTTP
200でMessage: "Item not found"。 - アップロードしたファイルが読み取り可能なPDFでない場合 → HTTP
200でMessage: "File is not a valid PDF."。 - アップロードがプランの最大ファイルサイズを超えた場合 → HTTP
413でMessage: "File exceeds the maximum allowed upload size."。
PDFの差し替え(URL) — PUT /api/replace-pdf-by-url/{flipbookId}:
- APIキーが欠けているか無効な場合 → HTTP
401。401 Unauthorized HTMLページを返し、JSONボディはありません。 - アイテムIDが見つからないか、キーが所有していない場合 → HTTP
200でMessage: "Item not found"。 - 不明またはスペルミスのボディフィールド → HTTP
200でMessage: "Unknown field(s) '…'. Expected: …"。
複製 — POST /api/duplicate/{flipbookId}:
- APIキーが欠けているか無効な場合 → HTTP
401。401 Unauthorized HTMLページを返し、JSONボディはありません。 - アイテムIDが見つからないか、キーが所有していない場合 → HTTP
200でMessage: "Item not found"。 - 不明またはスペルミスのボディフィールド → HTTP
200でMessage: "Unknown field(s) '…'. Expected: …"。