フリップブックをパスワードで保護する

アクセス制御

1回のAPI呼び出しで、フリップブックのパスワード保護をオン・オフし、パスワード画面（タイトル、入力欄のプレースホルダー、ボタン）をカスタマイズできます。

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

PUTSet Password Access/api/set-password-access/{flipbookId}

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

できること

パスワード保護は、フリップブックの前にゲートを設けます。ビューアーは、コンテンツが読み込まれる前に正しいパスワードを入力する必要があります。1回のAPI呼び出しで、次のことができます。

保護をオンにして、アクセス用パスワードを設定する。
保護を再びオフにする。
パスワード画面をカスタマイズする — 見出し、入力欄のプレースホルダー、ボタンのラベル。

始める前に

必要なものは次のとおりです。

APIキー — すべてのリクエストでX-Api-Keyヘッダーとして送ります。
flipbookId — フリップブックの作成時（IDとして）や一覧エンドポイントから返される数値IDです。
リクエストの送信先はベースURL https://go.fliplink.meです。

ボディはform-urlencoded（JSONではありません）です。

パラメーター

次のフィールドをurlencodedでPUT /api/set-password-access/{flipbookId}に送ります。

フィールド	型	動作
`IsPasswordProtected`	boolean	`true`でパスワードゲートをオン、`false`でオフ
`Password`	text	ビューアーが入力するアクセス用パスワード
`PwdTitle`	text	パスワード画面に表示する見出し（任意）
`PwdPlaceholder`	text	パスワード入力欄内のプレースホルダー（任意）
`PwdButton`	text	送信ボタンのラベル（任意）

パスワード保護をオンにする

IsPasswordProtected=trueを設定し、Passwordを指定します。3つのPwd*フィールドは任意です。ビューアーに表示される内容をカスタマイズしたい場合に含めてください。

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=true' \
  --data-urlencode 'Password=spring-2026' \
  --data-urlencode 'PwdTitle=Enter the access code' \
  --data-urlencode 'PwdPlaceholder=Access code' \
  --data-urlencode 'PwdButton=View document'

レスポンス:

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

パスワード保護をオフにする

IsPasswordProtected=falseを設定します。他のフィールドは空のままで構いません。

curl -X PUT 'https://go.fliplink.me/api/set-password-access/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsPasswordProtected=false' \
  --data-urlencode 'Password=' \
  --data-urlencode 'PwdTitle=' \
  --data-urlencode 'PwdPlaceholder=' \
  --data-urlencode 'PwdButton='