リード獲得フォームを設定する

できること

リード獲得フォームは、ビューアーがフリップブックを読む前に情報を集めるゲートです。4つのエンドポイントで、そのフォームをすべてAPIから作成・設定できます。

• 基本ゲートを有効にして設定する — リード獲得をオンにし、タイトルを設定し、スキップを許可（またはブロック）し、何ページ目でフォームが表示されるかを制御する。
• 標準フィールドを切り替える — 名前、メール、電話、会社、日付 — それぞれを必須または任意にする。
• 標準セット以外に、独自のラベルを持つ追加のカスタムフィールドを定義する。
• 各フィールドに表示される表示ラベルとプレースホルダーテキストを設定する。

各エンドポイントは{flipbookId}で1つのフリップブックを対象にし、1回のPUTで変更を適用します。

始める前に

• 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で送ってください。

基本ゲートを有効にして設定する

PUT /api/set-lead-capture/{flipbookId}は、基本のリード獲得フォームを有効にして設定します。有効化フラグはIsLeadCaptureです（IsEnabledを探してしまうのがよくある間違いです。そのフィールドはここには存在しません）。

curl -X PUT 'https://go.fliplink.me/api/set-lead-capture/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCapture=true' \
  --data-urlencode 'LeadCaptureTitle=Please share your details to continue' \
  --data-urlencode 'IsLeadAllowSkip=false' \
  --data-urlencode 'LeadSkipText=Skip' \
  --data-urlencode 'LeadFormAfterPages=0' \
  --data-urlencode 'LeadAfterPages=0'

レスポンス:

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

ボディには、有効化フラグ（IsLeadCapture）、フォームの見出し（LeadCaptureTitle）、スキップの切り替え（IsLeadAllowSkip）、そしてそのLeadSkipText（スキップボタンに表示されるラベル、デフォルトはSkip）が含まれます。また、独立した2つのページ数フィールドLeadFormAfterPagesとLeadAfterPagesがあり、それぞれ個別に保存されます。この2つのページ数は、フォームがいつ表示されるかのビューアー側のタイミングを制御します。望む動作に合わせて、両方を意図的に設定してください。

標準フィールドを切り替える

PUT /api/set-lead-fields/{flipbookId}は、各標準リード獲得フィールド（名前、メール、電話、会社、日付）と、それが必須かどうかを切り替えます。各フィールドには、表示するためのIs…フラグと、必須にするためのIs…Mandatoryフラグがあります。

ボディにはLeadPhoneCountryも含まれます。これは電話フィールドのデフォルトの国／国番号を設定します。USや+1のような値を受け付け、そのまま保存されます。デフォルトは空です。

curl -X PUT 'https://go.fliplink.me/api/set-lead-fields/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadEmail=true' \
  --data-urlencode 'IsLeadEmailMandatory=true' \
  --data-urlencode 'IsLeadName=true' \
  --data-urlencode 'IsLeadNameMandatory=false' \
  --data-urlencode 'IsLeadPhone=false' \
  --data-urlencode 'IsLeadPhoneMandatory=false' \
  --data-urlencode 'IsLeadCompany=false' \
  --data-urlencode 'IsLeadCompanyMandatory=false' \
  --data-urlencode 'IsLeadDate=false' \
  --data-urlencode 'IsLeadDateMandatory=false' \
  --data-urlencode 'LeadPhoneCountry='

レスポンス:

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

カスタムフィールドを定義する

PUT /api/set-lead-custom-fields/{flipbookId}は、標準の名前／メール／電話以外に、リード獲得フォームに追加のカスタムフィールドを定義します。各カスタムフィールドには、表示フラグ、必須フラグ、ラベルがあります。

curl -X PUT 'https://go.fliplink.me/api/set-lead-custom-fields/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadCustom1=false' \
  --data-urlencode 'IsLeadCustom1Mandatory=false' \
  --data-urlencode 'Custom1Label=' \
  --data-urlencode 'IsLeadCustom2=false' \
  --data-urlencode 'IsLeadCustom2Mandatory=false' \
  --data-urlencode 'Custom2Label='

レスポンス:

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

フィールドのラベルを設定する

PUT /api/set-lead-labels/{flipbookId}は、送信ボタンを含め、リード獲得フォームのフィールドの表示ラベルとプレースホルダーテキストを設定します。

curl -X PUT 'https://go.fliplink.me/api/set-lead-labels/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'LeadEmail=' \
  --data-urlencode 'LeadName=' \
  --data-urlencode 'LeadPhone=' \
  --data-urlencode 'LeadCompany=' \
  --data-urlencode 'LeadDate=' \
  --data-urlencode 'LeadButton='

レスポンス:

{
  "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: …"。上の例と各フィールド名の正確なスペルと大文字・小文字を合わせてください。

メモ

• リード獲得をオンにするには、フィールド、カスタムフィールド、ラベルのエンドポイントを頼りにする前に、set-lead-capture（IsLeadCapture=true）で有効にしてください。これらのエンドポイントは、基本ゲートが表示するフォームを設定するものです。