アナリティクストラッキングとAIアシスタント

できること

これら4つのエンドポイントでは、1つのホストされたフリップブックのトラッキングとAI機能を設定できます。いずれも{flipbookId}をキーにします。

• アナリティクストラッキングIDを追加する — Google Analytics、Google Tag Manager、Facebook Pixelのコード。
• AIプロバイダーを設定する — AI機能で使うプロバイダー名とそのAPIキー。
• バーチャルアシスタントを設定する — ビューアー内のチャット／ヘルプアシスタントの基本設定（ボタンのテキスト、色、プロンプト、埋め込み）。
• アシスタントのステータステキストを設定する — アシスタントが待機中、録音中、処理中、発話中に表示されるラベル。

始める前に

• APIキー — すべてのリクエストでX-Api-Keyヘッダー、またはAuthorization: Bearer YOUR_API_KEYとして送ります。
• {flipbookId} — フリップブック／ドキュメントの数値IDです。create-by-file／create-by-url（IDとして）や一覧から返されます。以下の4つのエンドポイントはいずれも、これをパスパラメーターとして取ります。
• すべてのリクエストの送信先はベースURL https://go.fliplink.meです。
• ここでの各エンドポイントのリクエストボディはform-urlencoded（JSONではありません）です。各フィールドは--data-urlencodeで送ってください。

アナリティクストラッキングIDを追加する

PUT /api/set-analytics-tracking/{flipbookId}は、独自のアナリティクストラッキングID（Google Analytics、GTM、Facebook Pixelなど）をホストされたフリップブックに追加します。

curl -X PUT 'https://go.fliplink.me/api/set-analytics-tracking/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'FacebookAnalyticsCode=' \
  --data-urlencode 'GoogleAnalyticsCode=' \
  --data-urlencode 'GoogleTagManager='

レスポンス:

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

AIプロバイダーを設定する

PUT /api/set-ai-provider/{flipbookId}は、AI機能で使うAIプロバイダーを設定します。プロバイダー名（AIProvider）とそのAPIキー（AIKey）です。

curl -X PUT 'https://go.fliplink.me/api/set-ai-provider/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'AIProvider=' \
  --data-urlencode 'AIKey='

レスポンス:

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

バーチャルアシスタントを設定する

PUT /api/set-virtual-assistant/{flipbookId}は、ビューアー内のバーチャルアシスタント（チャット／ヘルプ）の基本設定を行います。IsVAでアシスタントのオン・オフを切り替え、VATextにアシスタントのプロンプト／指示を、VAEmbeddingsに埋め込みのブロブ（文字列）を保持します。

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVA=false' \
  --data-urlencode 'VAButtonText=' \
  --data-urlencode 'VAButtonColor=' \
  --data-urlencode 'VAButtonTextColor=' \
  --data-urlencode 'VAText=' \
  --data-urlencode 'VAEmbeddings='

レスポンス:

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

アシスタントのステータステキストを設定する

PUT /api/set-virtual-assistant-status-text/{flipbookId}は、ビューアー内のバーチャルアシスタントが表示するステータス／あいさつのテキストを設定します。4つのフィールドは各状態のラベルです。VAButtonStatus1（待機中）、VAButtonStatus2（録音中）、VAButtonStatus3（処理中）、VAButtonStatus4（発話中）。

curl -X PUT 'https://go.fliplink.me/api/set-virtual-assistant-status-text/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'VAButtonStatus1=' \
  --data-urlencode 'VAButtonStatus2=' \
  --data-urlencode 'VAButtonStatus3=' \
  --data-urlencode 'VAButtonStatus4='

レスポンス:

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

起こりうるエラー

4つのエンドポイントは、いずれも同じエラー動作をします。

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