リードのプライバシーとメール認証

リード獲得

フリップブックのリード獲得のプライバシー/同意テキストとオプションを設定し、ビューアーのメール認証をオン・オフできます。すべてAPIで行います。

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

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

できること

フリップブックがリードを獲得するとき、その体験の2つの部分をAPIで整えられます。

  • プライバシー/同意 — リード獲得のプライバシー/同意テキストとオプション(たとえばGDPRの同意チェックボックス)を、プライバシーポリシーへのリンクを含めて設定する。
  • メール認証 — リードのメール認証をオン・オフし、アクセス前にビューアーにメールの確認を求める。

始める前に

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

  • 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ではありません)です。

プライバシーと同意を設定する

PUT /api/set-lead-privacy/{flipbookId}は、リード獲得のプライバシー/同意テキストとオプション(GDPRの同意チェックボックスなど)を設定します。

curl -X PUT 'https://go.fliplink.me/api/set-lead-privacy/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsLeadPrivacyPolicy=false' \
  --data-urlencode 'PrivacyPolicyURL=' \
  --data-urlencode 'PrivacyPolicyText='

レスポンス:

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

メール認証を設定する

PUT /api/set-lead-verification/{flipbookId}は、リードのメール認証をオン・オフし、アクセス前にビューアーにメールの確認を求めます。

curl -X PUT 'https://go.fliplink.me/api/set-lead-verification/96216' \
  -H 'X-Api-Key: YOUR_API_KEY' \
  --data-urlencode 'IsVerifyEmail=false' \
  --data-urlencode 'IsVerifyMobile=false' \
  --data-urlencode 'TwillioAPIKey=' \
  --data-urlencode 'EmailVerifyTitleText=' \
  --data-urlencode 'EmailVerifyButtonText='

レスポンス:

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

起こりうるエラー

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

メモ

  • TwillioAPIKeyフィールドは、元のTwillioというスペルのままです。その正確な名前で送ってください。

関連ディスカッション