跳转到主要内容
POST
產生用於單一登入(SSO)的 JSON Web Token(JWT)。 詳情請參閱 Generate 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 body 參數的替代方式。當提供時,產生的 JWT URL 將使用你自己的 X Developer App 進行 OAuth 連結。
X-Twitter-OAuth1-Api-Secret
string
你從 X Developer Portal 取得的 X API Secret(Consumer Secret)。是 twitterApiSecret body 參數的替代方式。當提供了 X-Twitter-OAuth1-Api-Key 時為必填。
**建議:**透過標頭(X-Twitter-OAuth1-Api-KeyX-Twitter-OAuth1-Api-Secret)傳遞你的 X 認證資料,以便與所有其他 Ayrshare API 端點的做法保持一致。為了向下相容,仍然支援 twitterApiKeytwitterApiSecret body 參數。

Body 參數

domain
string
必填
App 的網域。請使用你在導入期間所取得的確切網域。
privateKey
string
必填
用於加密的 Private Key。
profileKey
string
必填
User Profile Key。此欄位不能使用 API Key。
logout
boolean
默认值:false
自動登出目前的工作階段。建議不要在正式環境中使用,因為會影響效能。更多資訊請參閱自動登出 Profile 工作階段
redirect
string
指定當使用者點擊「Done」按鈕或 Logo 圖片時要轉向的 URL。該 URL 會在回傳的 JWT URL 中自動被縮短。若要轉向原始開啟者視窗,請在 redirect URL 中加入 origin=true 查詢參數。
allowedSocial
array
指定要在連結頁面上顯示的社群網路。此設定會覆寫 Social Networks 頁面所設定的社群網路。
Only display Facebook, X/Twitter, LinkedIn, and TikTok
針對此 URL,覆寫使用者在社群連結頁面點擊 Instagram 按鈕時所使用的 Instagram 連結流程。有效值:
  • instagram:直接的 Instagram Login,不需 Facebook 粉絲專頁。
  • facebook:透過已連結的 Facebook 粉絲專頁連結 Instagram。
Force direct Instagram Login for this linking session
若省略此欄位,連結頁面將沿用你的帳號層級 Instagram Login 設定。更多資訊請參閱 Instagram 連結方式
verify
boolean
默认值:false
驗證產生的 Token 是否有效。建議僅在非正式環境使用。更多資訊請參閱開啟與關閉社群連結 URL
base64
boolean
默认值:false
若 Private Key 為 base64 編碼,請設為 true將 private.key 檔案以 base64 編碼,並將產生的單行字串以 privateKey 欄位傳入。例如在 Linux 中:cat private.key | base64
expiresIn
number
默认值:5
設定 Token 的有效期,單位為分鐘。範圍:1 分鐘至 2880 分鐘。更多資訊請參閱 JWT Expires In
email
object
默认值:5
寄送 Connect Accounts 電子郵件,內含可讓使用者直接前往社群連結頁面的連結。更多資訊請參閱 Connect Accounts 電子郵件
當你附上 X API 認證資料時,產生的 JWT URL 將以你自己的 X Developer App 啟動 OAuth 連結流程。你的終端使用者會在 X 的授權同意畫面上看到你的 App 名稱。
**必要條件:**在使用此功能之前,你必須在 X Developer App 設定中(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 錯誤。