Skip to main content
POST
为 User Profile 创建社交账号链接 URL。该端点仍名为 generateJWT,但它返回的 token 是不透明字符串,并不是 JWT。 更多细节请参阅社交关联概览。
链接 URL 的有效期为 5 分钟。5 分钟后必须重新生成链接 URL。 更多选项请参阅 Max Pack expiresIn 的附加选项。
此端点已弃用。 它仍受完全支持、没有移除日期,并保持原样继续工作——只是不再是创建链接 URL 的推荐方式。返回的 token 是以 ayr_ls_ 开头的不透明字符串,它不是可解码的 JWT,也不包含可读的 payload。请将 url 按原样交给您的用户,并把 token 当作需要保存而非解析的凭据。此前创建的 链接仍然有效。POST /profiles/link-sessions 执行相同的操作,但不需要这些旧参数,还支持查询或吊销某个链接。 参见创建 Link Session。

Header 参数

string
来自 X Developer Portal 的 X API Key(Consumer Key)。作为 twitterApiKey body 参数的替代方案。当提供该值时,生成的链接 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-Key 和 X-Twitter-OAuth1-Api-Secret),以与所有其他 Ayrshare API 端点保持一致。为了向后兼容,body 参数 twitterApiKey 和 twitterApiSecret 依然受支持。

Body 参数

string
应用的 domain。请使用开通 (onboarding) 时提供的完整 domain。可选。省略时使用您账户自身的 domain。如果发送,它必须是已注册到您账户的 domain。
string
已弃用
已不再使用。该字段仍会被接受并忽略,因此现有集成无需改动即可继续工作。链接 URL 不再签名,因此无需发送任何密钥。您可以移除该字段,并不再为此保存 private key。
string
必填
User Profile Key。此字段不可使用 API Key。
boolean
默认值:false
自动登出当前会话。不建议在生产环境中使用,因为会影响性能。更多信息请参阅自动登出 Profile 会话。
string
指定当点击 “Done” 按钮或 logo 图片时要跳转到的 URL。返回的链接 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
已弃用
已不再使用。该字段仍会被接受并忽略。没有需要验证的签名 token:返回的 token 会在您的用户打开该 URL 时由链接页面校验。
boolean
已弃用
已不再使用。由于不再读取 privateKey,该字段仍会被接受并忽略。
number
默认值:5
以分钟为单位设置 token 的有效期。范围:1 分钟至 2880 分钟。更多信息请参阅链接有效期。
object
发送一封 Connect Accounts 邮件,附带用户直接访问其社交关联页面的链接。如果邮件无法发送,您仍然会拿到链接。响应中会包含 emailSent: false 和一个 emailError 对象,这样您可以通过其他方式把链接发给用户。更多信息请参阅 Connect Accounts 邮件。
当你提供 X API 凭据时,生成的链接 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 错误。