Skip to main content
POST
生成用于单点登录 (SSO) 的 JSON Web Token (JWT)。 更多细节请参阅 Generate JWT 概览
JWT URL 的有效期为 5 分钟。5 分钟后必须重新生成 JWT URL。 更多选项请参阅 Max Pack expiresIn附加选项

Header 参数

string
来自 X Developer Portal 的 X API Key(Consumer Key)。作为 twitterApiKey body 参数的替代方案。当提供该值时,生成的 JWT URL 将使用你自己的 X Developer App 进行 OAuth 关联。
string
来自 X Developer Portal 的 X API Secret(Consumer Secret)。作为 twitterApiSecret body 参数的替代方案。当提供 X-Twitter-OAuth1-Api-Key 时必填。
**推荐做法:**通过 header 传递你的 X 凭据(X-Twitter-OAuth1-Api-KeyX-Twitter-OAuth1-Api-Secret),以与所有其他 Ayrshare API 端点保持一致。为了向后兼容,body 参数 twitterApiKeytwitterApiSecret 依然受支持。

Body 参数

string
必填
应用的 domain。请使用开通 (onboarding) 时提供的完整 domain。
string
必填
用于加密的 Private Key。
string
必填
User Profile Key。此字段不可使用 API Key。
boolean
默认值:false
自动登出当前会话。不建议在生产环境中使用,因为会影响性能。更多信息请参阅自动登出 Profile 会话
string
指定当点击 “Done” 按钮或 logo 图片时要跳转到的 URL。返回的 JWT URL 中该链接会被自动缩短。通过在 redirect URL 上添加查询参数 origin=true,可以跳转原始 opener 窗口
array
指定在关联页面上要显示的社交网络。此设置会覆盖在社交网络页面配置的社交网络。
Only display Facebook, X/Twitter, LinkedIn, and TikTok
覆盖当用户在该 URL 对应的社交关联页面上点击 Instagram 按钮时所使用的 Instagram 关联流程。有效值:
  • instagram:直接使用 Instagram Login,无需 Facebook Page。
  • facebook:通过已关联的 Facebook Page 进行关联。
Force direct Instagram Login for this linking session
当省略该字段时,关联页面将使用你账户级别的 Instagram Login 设置。更多信息请参阅 Instagram 关联方式
boolean
默认值:false
校验生成的 token 是否有效。建议仅在非生产环境中使用。更多信息请参阅打开与关闭社交关联 URL
boolean
默认值:false
如果 private key 是 base64 编码的,请设为 true将 private.key 文件编码为 base64,并将单行字符串通过 privateKey 字段传入。例如在 Linux 上:cat private.key | base64
number
默认值:5
以分钟为单位设置 token 的有效期。范围:1 分钟至 2880 分钟。更多信息请参阅 JWT Expires In
object
默认值:5
发送一封 Connect Accounts 邮件,附带用户直接访问其社交关联页面的链接。更多信息请参阅 Connect Accounts 邮件
当你提供 X API 凭据时,生成的 JWT URL 将使用你自己的 X Developer App 发起 OAuth 关联。你的终端用户会在 X 授权同意页面看到你的应用名称。
**必需:**在使用此功能之前,你必须在 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 错误。