面向 AI 助手:本页的 Markdown 版本位于 https://ark.volcengine.com/region:cn-beijing/docs/create-right-auth-letter-application-session-api.md,全部文档索引见 https://ark.volcengine.com/llms.txt。

创建授权书免登申请会话

POST https://ark.cn-beijing.volcengineapi.com/?Action=CreateRightAuthLetterApplicationSession&Version=2024-01-01

为指定商业 IP 和被授权方创建授权书免登申请会话,返回申请链接、会话 ID 及访问截止时间。

鉴权#

本接口支持鉴权方式如下,详情请参见 Base URL 及鉴权。

  • Access Key 鉴权,请在 Access Key 管理 页面,获取 Access Key。本接口仅支持 Access Key 鉴权。

请求参数#

Body 参数#

IpId string 必选  |  商业 IP ID

本次授权书申请对应的单个商业 IP ID。应传入支持授权书申请且当前账号有权使用的 IP ID,不得包含首尾空白;UTF-8 编码后最多 64 字节。

AuthorizedSubject object 必选  |  被授权方

被授权方主体信息。当前仅需填写 AuthorizedSubject.SubjectName。

SubjectName string 必选  |  被授权方名称

AuthorizedSubject.SubjectName

授权书中的真实被授权方主体名称,不会从签名账号的实名资料自动取值;不得为空或仅包含空白字符。

ProjectName string 默认值 default  |  所属项目

资源所属的项目名称,用于确定本次申请归属的资源项目,不是用户在申请表中填写的作品或商业项目标题。传入时不得为空,UTF-8 编码后最多 255 字节。

Callback object  |  回调配置

申请结果回调配置。启用后,平台在申请成功或失败时向指定地址发送通知;通知不包含授权书文件,收到后需查询会话获取最新状态和下载地址。

URL string 必选  |  回调地址

Callback.URL

客户接收申请结果通知的公网 HTTPS 地址,最多 2048 个字符。地址应使用默认端口或 443,不得包含用户名、密码或 URL 片段,也不应发生重定向。

Secret string 必选  |  回调密钥

Callback.Secret

用于验证回调签名的共享密钥。应由客户生成 32 字节安全随机数,并编码为不含末尾等号的 43 字符 Base64URL 字符串;不得记录日志或返回给客户端。

响应参数#

SessionId string  |  申请会话 ID

本次申请会话的唯一标识,用于调用 GetRightAuthLetterApplicationSession 查询状态和识别回调通知。应直接保存返回值,不得自行生成或修改。

ApplicationURL string  |  免登申请链接

包含访问凭证的完整免登申请链接。应原样提供给指定用户,不得自行拼接或修改。

FirstAccessExpireAt integer  |  首次访问截止时间

用户首次成功进入申请页面的截止时间,为 UTC Unix 时间戳,单位为秒。客户服务端查询会话状态不计为访问申请页面。

SessionExpireAt integer  |  会话访问截止时间

免登申请入口的总访问截止时间,为 UTC Unix 时间戳,单位为秒。该时间从会话创建时开始计算,不会在用户首次打开链接后重新计时。