Skip to main content
POST
User Profile のソーシャル連携用 URL を作成します。エンドポイント名は引き続き generateJWT ですが、返されるトークンは不透明な文字列であり JWT ではありません。 詳細については、リンク用 URL の概要をご覧ください。
リンク用 URLの有効期限は5分間です。5分後には、新しいリンク用 URLを生成する必要があります。 追加オプションについては、Max PackのexpiresInをご覧ください。
返される tokenayr_ls_ で始まる不透明な文字列です。デコード可能な JWT ではなく、 読み取れるペイロードは含まれません。url は返されたままユーザーに渡し、token は中身を調べる ものではなく保管する資格情報として扱ってください。すでに作成済みのリンクは引き続き利用できます。POST /profiles/link-sessions は同じ処理をレガシーパラメータなしで行い、さらにリンクの状態確認や 失効も可能です。Link Session の作成を参照してください。

ヘッダーパラメータ

string
X Developer PortalからのX API Key(Consumer Key)。twitterApiKeyボディパラメータの代替となります。指定すると、生成されるリンク用 URLはOAuth連携にあなたのXデベロッパーアプリを使用します。
string
X Developer PortalからのX API Secret(Consumer Secret)。twitterApiSecretボディパラメータの代替となります。X-Twitter-OAuth1-Api-Keyが指定されている場合は必須です。
推奨: 他のすべてのAyrshare APIエンドポイントとの一貫性のため、X認証情報をヘッダー(X-Twitter-OAuth1-Api-KeyおよびX-Twitter-OAuth1-Api-Secret)経由で渡してください。twitterApiKeyおよびtwitterApiSecretボディパラメータは、後方互換性のため引き続きサポートされます。

ボディパラメータ

string
アプリのドメイン。オンボーディング中に付与された正確なドメインを使用してください。任意。省略した場合はアカウント自身のドメインが使用されます。送信する場合は、アカウントに登録済みのドメインである必要があります。
string
非推奨
現在は使用されていません。フィールドは受け付けられますが無視されるため、既存の連携は変更なしで動作し続けます。リンク用 URL は署名されなくなったため、送信する鍵はありません。このフィールドは削除でき、この用途のために秘密鍵を保管する必要もなくなります。
string
必須
User Profile Key。このフィールドではAPI Keyを使用できません。
boolean
デフォルト:false
現在のセッションを自動的にログアウトします。パフォーマンスに影響するため、本番環境での使用は推奨しません。詳細については、プロフィールセッションの自動ログアウトをご覧ください。
string
「Done」ボタンまたはロゴ画像がクリックされたときにリダイレクトするURLを指定します。URLは返されるリンク用 URL内で自動的に短縮されます。リダイレクトURLにクエリパラメータorigin=trueを追加することで、オリジンオープナーウィンドウのリダイレクトができます。
array
連携ページに表示するソーシャルネットワークを指定します。これにより、Social Networksページで構成されたソーシャルネットワークが上書きされます。
Only display Facebook, X/Twitter, LinkedIn, and TikTok
このURLのソーシャル連携ページでユーザーがInstagramボタンをクリックしたときに使用するInstagram連携フローを上書きします。有効な値:
  • instagram: Direct Instagram Login、Facebookページ不要。
  • facebook: 連携済みのFacebookページを経由してInstagramを連携。
Force direct Instagram Login for this linking session
省略した場合、連携ページはアカウント全体のInstagram Login設定を使用します。詳細については、Instagram連携方法をご覧ください。
boolean
非推奨
現在は使用されていません。フィールドは受け付けられますが無視されます。検証すべき署名付きトークンはありません。返される token は、ユーザーが URL を開いたときにリンクページ側で検証されます。
boolean
非推奨
現在は使用されていません。privateKey が読み取られなくなったため、フィールドは受け付けられますが無視されます。
number
デフォルト:5
トークンの有効期間を分単位で設定します。範囲: 1分から2880分。詳細については、JWTの有効期限をご覧ください。
object
デフォルト:5
ソーシャル連携ページに直接アクセスするためのリンクを含むConnect Accountsメールを送信します。詳細については、Connect Accountsメールをご覧ください。
X API認証情報を含めると、生成されるリンク用 URLは自身のXデベロッパーアプリを使用してOAuth連携を開始します。エンドユーザーはX承認画面であなたのアプリ名を目にすることになります。
必須: この機能を使用する前に、Xデベロッパーアプリ設定(Authentication settings > Callback URI / Redirect URL)に以下のコールバックURLを追加する必要があります:
  • https://profile.ayrshare.com/social-accounts
  • https://app.ayrshare.com/social-accounts
これらがない場合、OAuthフローは403 Callback URL not approvedエラーで失敗します。