Skip to main content
POST
User Profile のソーシャル連携用 URL を作成します。返された url をユーザーに送ると、ユーザーはそれを開いてソーシャルアカウントを連携できます。 これがリンク用 URL を作成する推奨の方法です。必要なのは API Key と Profile-Key だけで、送信する秘密鍵も署名するものもありません。従来の方法で作成したリンク用 URL と異なり、Link Session は保存されるため、使用されたかどうかを確認でき、期限切れ前に失効させることもできます。 返された url はユーザーをそのプロファイルにサインインさせるため、パスワードと同様に扱い、各 URL は 1 人のユーザーにのみ送信してください。 リンク用 URL の送信を参照してください。
URL はデフォルトで 5 分間 有効です。別の有効期間を設定するには expiresIn を使用してください。 最大 2880 分(48 時間)まで設定できます。
リンク用 URL の生成は同じ処理を行い、引き続き変更なしで動作します。 レガシーの privateKeybase64verify パラメータは受け付けられますが無視されます。domain は どちらのエンドポイントでも無視されません — 引き続き任意であり、バリデーションも行われます。 新しい実装ではこのエンドポイントを使用してください。レスポンスには 1 つ違いがあります: generateJWT は後方互換性のためにトップレベルの token を返しますが、 このエンドポイントが url並べてトークンを返すことはありません — url のトークンはその中に 存在します。移行中でコードが token を読み取っている場合は、代わりに url を読み取ってください。 (埋め込みウィジェット用の Connect モードだけが token を単体で返す形です。 トークンを載せる URL が返されないためです。)

ヘッダーパラメータ

Profile-Key はこのエンドポイントではヘッダーです — profileKey ボディパラメータはありません。 欠落している場合は code: 188 が返され、そのメッセージには privateKeyprofileKey などの レガシーなフィールド名が列挙されます。これはリンク用 URL の生成と 共有されているためです。「Profile-Key ヘッダーが欠落しているか誤っている」と読み替えてください。 メッセージ内の他の名前は、このエンドポイントのパラメータではありません。
string
X Developer Portal からの X API Key(Consumer Key)。指定すると、リンク用 URL は OAuth 連携に あなた自身の X デベロッパーアプリを使用します。
string
X Developer Portal からの X API Secret(Consumer Secret)。X-Twitter-OAuth1-Api-Key が指定されている 場合は必須です。

ボディパラメータ

string
デフォルト:"grid"
このセッションがどのリンクサーフェスを駆動するか。
  • grid — ホスト型リンクページ。許可しているすべてのネットワークを表示します。これがデフォルト なので、mode を省略したリクエストはこれを作成します。
  • connect — 貴社自身のダッシュボードから開く、一度に 1 ネットワークの連携。下記の Connect モードダイレクトモードを 参照してください。
推測されることはありません: originnetwork を渡しても connect モードにはならないため、 grid セッションが誤ってゲート付きのセッションになることはありません。それ以外の値は、details に 2 つの有効な値を挙げた code: 188 を返します。
number
デフォルト:5
リンクの有効期間を分単位で設定します。範囲: 1 分から 2880 分。Max Pack が必要です。詳細については、リンクの有効期限をご覧ください。
boolean
デフォルト:false
現在のセッションを自動的にログアウトします。パフォーマンスに影響するため、本番環境での使用は推奨しません。詳細については、プロフィールセッションの自動ログアウトをご覧ください。
string
「Done」ボタンまたはロゴ画像がクリックされたときにリダイレクトする URL。オープナーウィンドウを リダイレクトするには、クエリパラメータ origin=true を追加してください。
array
連携ページに表示するソーシャルネットワークを指定します。これにより、Social Networksページで構成された ソーシャルネットワークが上書きされます。
Only display Facebook, X/Twitter, LinkedIn, and TikTok
string
Connect モード専用。このセッションが接続する単一のソーシャルネットワークで、これを指定すると ダイレクトモードのセッションになります。貴社のダッシュボードが複数ネットワークにわたって 駆動するセッションでは省略してください。blueskyfacebookgmbinstagraminstagramApilinkedinpinterestredditsnapchattelegramthreadstiktoktwitterwhatsappxyoutube のいずれか。 それ以外は code: 508 を返します — fbg もここではリンク対象でないため含まれます。allowedSocial と組み合わせることはできません(code: 507): 単一ネットワークのセッションは、 それ自体がすでにホワイトリストだからです。アカウントで有効になっていないネットワークは code: 509 を返します。これは 508 とは意図的に区別されており、 Social Networks ページで自分で 修正できます。grid モードでは無視されます。
このリンクで使用する Instagram 連携フローを上書きします。有効な値:
  • instagram: Direct Instagram Login、Facebook ページ不要。
  • facebook: 連携済みの Facebook ページを経由して Instagram を連携。
省略した場合、連携ページはアカウント全体の Instagram Login 設定を使用します。
string
リンクウィンドウを開いたページの正確なオリジン。連携の完了時に通知を受け取れるようにします。設定すると、ユーザーが各アカウントを接続するたびに、リンクページが window.postMessage でその オリジンにイベントを post し、貴社のページはポーリングなしで反応できます。イベントはこの正確な 値にのみ送信されるため、スキームやポートを含め、貴社のページのオリジンと 1 文字違わず一致する 必要があります。受け付けられる形は 3 つです: https オリジン(https://app.example.com)、ローカル開発用の http://localhost:3000、ネイティブのカスタムスキーム(myapp://connected)。それ以外 — localhost 以外の素の http:// オリジンや、そもそもオリジンでないもの — は、このエンドポイントが 作成するリンクでは無視されます: リンクは動作しますが、イベントは送信されません。任意なので、 省略してもエラーにはなりません。3 つのうちイベントを受信できるのは最初の 2 つだけです。カスタムスキームはモバイルアプリの戻り先で あり、イベントを受信できません。post する先のブラウザウィンドウが存在しないためです。ネイティブ アプリは代わりに Link Session の取得をポーリングします。リンク完了イベントを参照してください。connect モードでは origin は必須であり、チェックされます。 上記の寛容な扱いは grid モードの 挙動です。mode: "connect" では、省略すると code: 505 が返され、受け付けられる 3 つの形の いずれでもない値は code: 506 を返します。その details には送信した形がそのまま示されます。
string
任意。アカウントに複数のリンク用ドメインがある場合に指定する、あなたのリンク用ドメイン。省略した場合は アカウント自身のドメインが使用されます。アカウントに登録されていないドメインは拒否されます。
object
リンクを含む Connect Accounts メールを送信し、ユーザーが連携ページに直接アクセスできるようにします。 to アドレスが必要です。Max Pack が必要です。送信結果はレスポンスの emailSent に反映され、送信に失敗した場合は成功レスポンス ではなく code: 333 が返されます。詳細については、Connect Accounts メールをご覧ください。

Connect モード

mode: "connect" は、ホスト型リンクページではなく、貴社自身がホストするリンクサーフェス用の セッションを作成します。2 つある connect の形のどちらになるかは、network を渡すかどうか、その 1 点で決まります:
レスポンスがシークレットを運ぶのはちょうど 1 回です。 レスポンスには urltoken の どちらか一方があり、両方を持つことも URL が 2 つになることもありません。ダイレクトモードの セッションのトークンは、grid モードと同じように url の中にあります。トークンを載せる URL の ないセッションは、代わりに token を単体で返します。それ以外は 3 つのモードすべてで同じです: sessionIdexpiresAtemailSent、そして User Profile に設定されていれば title

Connect モードに必要なもの

どちらもそれ自体がボディフィールドなのではありません — 1 つ目はアカウントの権限で、2 つ目は上記の origin パラメータであり、connect モードはこれを必須にします。 Max Pack これがないと呼び出しは code: 504 を返します。connect モードの パラメータより先にチェックされるため、originnetwork を修正しても結果は変わりません。Max Pack のないアカウントで connect モードを有効にする必要がある場合は、サポートにお問い合わせください。 すべてのセッションに origin ホワイトリストも登録手順もありません — 呼び出しごとに送信し、 セッションに保存されるため、新しい環境で当社側の設定は不要です。受け付けられる形は 3 つです:
  • https オリジン — https://app.example.com
  • ネイティブのカスタムスキーム — myapp://connected
  • http://localhost または http://localhost:3000(ローカル開発用)
オリジンのみです: パス、クエリ、フラグメント、認証情報を含めてはいけません。省略すると code: 505 が返され、3 つの形のいずれでもないものは code: 506 を返します。
emailnetwork のないセッションでは使用できません。メールに載せるリンクが存在しない からです — その形は貴社のフロントエンド用のトークンを返します。呼び出しは code: 510 を返します。 URL を持つダイレクトモードのセッションにするために network を追加するか、email を省略して ください。
上記のすべてのコードは Link Session エラー リファレンスに記載されています。