共有のコントロールとチャネル

共有

マスタースイッチでビューアーの共有ボタンをオン・オフし、Facebook、X、LinkedIn、WhatsApp、メールなど各ソーシャルチャネルを個別に切り替えられます。

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

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

できること

2つのエンドポイントで、フリップブックの共有ボタンがビューアーにどう表示されるかを制御できます。

  • マスタースイッチ — 共有ボタンのセット全体を1回の呼び出しでオン・オフする。
  • チャネルごとの切り替え — ビューアーの共有メニューに、どのソーシャルチャネル(Facebook、X、LinkedIn、WhatsApp、メールなど)を表示するかを正確に決める。

どちらも{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ではありません)を取ります。各フィールドの値は、テキストとして送るブール値(true / false)です。

共有ボタンをオン・オフする

PUT /api/set-share-master/{flipbookId}は、ビューアーの共有ボタンのマスターのオン・オフスイッチです。

curl -X PUT 'https://go.fliplink.me/api/set-share-master/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareButtons=false'

レスポンス:

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

個別の共有チャネルを切り替える

PUT /api/set-share-channels/{flipbookId}は、ビューアーの共有メニューで、各ソーシャル共有チャネル(Facebook、X、LinkedIn、WhatsApp、メールなど)を個別に切り替えます。チャネルを表示するにはtrue、隠すにはfalseを送ります。

curl -X PUT 'https://go.fliplink.me/api/set-share-channels/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsShareFacebook=true' \
  --data-urlencode 'IsShareTwitter=true' \
  --data-urlencode 'IsShareWhatsApp=true' \
  --data-urlencode 'IsShareTelegram=false' \
  --data-urlencode 'IsShareLinkedIn=true' \
  --data-urlencode 'IsSharePinterest=false' \
  --data-urlencode 'IsShareReddit=false' \
  --data-urlencode 'IsShareTumblr=false' \
  --data-urlencode 'IsShareMessenger=false' \
  --data-urlencode 'IsShareEmail=true' \
  --data-urlencode 'IsShareLine=false' \
  --data-urlencode 'IsShareWeChat=false' \
  --data-urlencode 'IsShareInstagram=false' \
  --data-urlencode 'IsShareFlipboard=false' \
  --data-urlencode 'IsShareGeneral=true'

レスポンス:

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

起こりうるエラー

  • APIキーが欠けているか無効な場合 → HTTP 401。これはプレーンなUnauthorized HTMLページを返し、JSONボディはありませんX-Api-Keyヘッダー(またはAuthorization: Bearer)が存在し、正しいことを確認してください。
  • アイテムIDが見つからないか、キーが所有していない場合 → HTTP 200MessageItem not found
  • 不明またはスペルミスのボディフィールド → HTTP 200MessageUnknown field(s) '…'. Expected: …