メインコンテンツへスキップ
POST
シングルサインオンで使用するJSON Web Token(JWT)を生成します。 詳細については、JWT生成の概要をご覧ください。
JWT URLの有効期限は5分間です。5分後には、新しいJWT URLを生成する必要があります。 追加オプションについては、Max PackのexpiresInをご覧ください。

ヘッダーパラメータ

X-Twitter-OAuth1-Api-Key
string
X Developer PortalからのX API Key(Consumer Key)。twitterApiKeyボディパラメータの代替となります。指定すると、生成されるJWT URLはOAuth連携にあなたのXデベロッパーアプリを使用します。
X-Twitter-OAuth1-Api-Secret
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ボディパラメータは、後方互換性のため引き続きサポートされます。

ボディパラメータ

domain
string
必須
アプリのドメイン。オンボーディング中に付与された正確なドメインを使用してください。
privateKey
string
必須
暗号化に使用する秘密鍵。
profileKey
string
必須
User Profile Key。このフィールドではAPI Keyを使用できません。
logout
boolean
デフォルト:false
現在のセッションを自動的にログアウトします。パフォーマンスに影響するため、本番環境での使用は推奨しません。詳細については、プロフィールセッションの自動ログアウトをご覧ください。
redirect
string
「Done」ボタンまたはロゴ画像がクリックされたときにリダイレクトするURLを指定します。URLは返されるJWT URL内で自動的に短縮されます。リダイレクトURLにクエリパラメータorigin=trueを追加することで、オリジンオープナーウィンドウのリダイレクトができます。
allowedSocial
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連携方法をご覧ください。
verify
boolean
デフォルト:false
生成されたトークンが有効かどうかを検証します。本番環境以外での使用のみ推奨します。詳細については、ソーシャル連携URLのオープンとクローズをご覧ください。
base64
boolean
デフォルト:false
秘密鍵がbase64エンコードされている場合は、trueに設定します。private.keyファイルをbase64でエンコードし、単一行の文字列をprivateKeyフィールドに渡します。例(Linux): cat private.key | base64
expiresIn
number
デフォルト:5
トークンの有効期間を分単位で設定します。範囲: 1分から2880分。詳細については、JWTの有効期限をご覧ください。
email
object
デフォルト:5
ソーシャル連携ページに直接アクセスするためのリンクを含むConnect Accountsメールを送信します。詳細については、Connect Accountsメールをご覧ください。
X API認証情報を含めると、生成されるJWT 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エラーで失敗します。