获取内嵌页 URL
POST/openapi/v1/embedded/views
用 access_token 换取内嵌页 URL。在 WebView 中打开返回的 Url,用户即可在内嵌页中发起签署或查看合同列表,WebView 内部无需额外认证。
OperateType 取值:
| OperateType | 内嵌页内容 | OperateParam 参数 |
|---|---|---|
request_signatures | 发起签署(3步流程:设置接收人 → 放置签名区域 → 发送) | FileIds(必填)、CanEditFiles(可选)、Lang(可选) |
signature_status | 当前用户在该 Space 下的合同列表 | Lang(可选) |
FileIds 通过 POST /openapi/v1/files/upload 获取,需在 24 小时有效期内使用,且必须为 PDF 格式。非 PDF 文件需先调用 POST /openapi/v1/files/convert-tasks 转换为 PDF。
用户完成发起流程后(request_signatures):内嵌页展示发送成功页,提供查看合同和合同列表两个按钮,均在 WebView 内导航,不会跳出您的应用。
URL 有效期: 返回的 Url(含内嵌 token)有效期为 12 小时,请勿缓存复用,每次使用前重新获取。
请求参数
Header 参数
Authorization必填string
Bearer <access_token>
X-Operator-User-Id选填string
操作用户 ID。授权码模式下无需传(自动使用授权用户);客户端凭据模式下可选,不填时使用系统用户 ID。
Body 请求体
application/jsonOperateType必填string
内嵌页类型。
- `request_signatures`:打开发起签署的3步流程(设置接收人 → 放置签名区域 → 发送)。需传 `OperateParam`,其中 `FileIds` 必填。
- `signature_status`:打开当前用户在该 Space 下的合同列表。可传 `OperateParam`,仅 `Lang` 可选。
request_signaturessignature_status
OperateParam选填object
与 `OperateType` 配套的参数对象。不同模式下各参数的适用性不同:
- **request_signatures** 模式:`FileIds`(必填)、`CanEditFiles`(可选)、`Lang`(可选)
- **signature_status** 模式:仅 `Lang`(可选),其他参数不适用
未提供的可选参数使用默认值。
FileIds选填array<string>
内嵌页中可使用的文件 ID 列表。**仅 `request_signatures` 模式下必填。**通过 `POST /openapi/v1/files/upload` 获取。每个 FileId 须在 24 小时有效期内,且归属当前用户的 Space。文件必须为 PDF 格式;非 PDF 文件请先调用 `POST /openapi/v1/files/convert-tasks` 转换为 PDF 后再传入。
CanEditFiles选填boolean
**仅 `request_signatures` 模式适用。**是否允许在内嵌页中编辑文件(重新上传/删除)。可选,默认 `false`。启用后内嵌页 URL 会附带 `CanEditFiles` 参数。
Lang选填string
界面语言,两种模式均可使用。可选值 `en`(英语)、`zh-CN`(简体中文)、`zh-HK`(繁体中文)、`id`(印尼语)、`ms`(马来语)、`th`(泰语)、`vi`(越南语)。传入后内嵌页 URL 会附带 `Lang` 参数;不传则使用当前用户个人资料中的语言设置。
enzh-CNzh-HKidmsthvi
响应参数
Response.Data
Url选填string
内嵌页 URL。直接在 WebView 中打开此 URL。URL 中含一次性内嵌 token,有效期 12 小时,请勿缓存复用,每次使用前重新获取。
ExpiresAt选填string(date-time)
内嵌 token 的过期时间(RFC3339 格式)。
错误码
| 错误码 | 说明 |
|---|---|
INVALID_REQUEST | 参数缺失或无效(如 OperateType 不支持、request_signatures 时 FileIds 为空) |
OPENAPI.EMBEDDED_FILE_MUST_BE_PDF | FileId 对应的文件不是 PDF 格式,需先调用 POST /openapi/v1/files/convert-tasks 转换为 PDF |
UNAUTHORIZED | access_token 缺失、无效或已过期 |
INTERNAL_ERROR | 服务端内部错误 |