调用方式
所有 Tencent eSign Open API 均通过 HTTPS 协议调用,响应数据格式统一为 JSON。
基础信息
接口前缀
/openapi/v1
协议
HTTPS(不支持 HTTP)
响应格式
JSON(Content-Type: application/json)
字符编码
UTF-8
环境域名
业务接口
| 环境 | 域名 | 说明 |
|---|---|---|
| 测试环境 | https://api.test.sign.tencent.com | 用于开发和测试 |
| 线上环境(新加坡) | https://sgapi.tencent-esign.com | 按地域分配,当前为新加坡节点 |
完整请求地址 = 环境域名 + 接口前缀 + 具体路径,例如:
https://sgapi.tencent-esign.com/openapi/v1/envelopes文件上传接口
文件上传类接口使用独立域名,且所有接口共用一个请求地址,通过 Header X-TC-Action 区分具体操作。详见文件管理接口文档。
| 环境 | 域名 | 说明 |
|---|---|---|
| 测试环境 | https://file.test.sign.tencent.com | 用于开发和测试 |
| 正式环境 | https://sgfile.tencent-esign.com | 生产环境 |
完整请求地址,例如:
POST https://sgfile.tencent-esign.com/请求方法与内容类型
| 接口类型 | 方法 | 请求 Content-Type |
|---|---|---|
| 业务接口(创建信封、查询详情等) | POST | application/json |
| 文件上传接口(上传文件、分片上传等) | POST | multipart/form-data |
| OAuth 令牌端点(获取/吊销令牌) | POST | application/x-www-form-urlencoded |
业务接口的请求参数通过 JSON Body 传递;OAuth 令牌端点的参数通过表单字段传递,详见请求鉴权。
操作用户
应用创建时会自动关联一个系统用户 ID。可通过 Header X-Operator-User-Id 指定本次调用的执行身份,不传时系统自动使用该系统用户 ID。
⚠️
部分接口(涉及信封级权限校验的场景,如创建、作废、催办等)要求必须传入真实用户 ID,且须为该 Space 的成员。是否必填以各接口文档为准。
SpaceId 说明
一个应用(AppId)可以安装到一个或多个 Space。获取令牌时需通过 space_id 参数指定本次操作的目标 Space,签发的 access_token 仅对该 Space 有效,后续业务 API 调用均在该 Space 下执行,无需再次传入 SpaceId。
时间格式
所有时间字段均为 RFC3339/ISO 8601 格式,支持任意时区偏移:
2024-01-15T10:30:00Z(UTC)2024-01-15T18:30:00+08:00(UTC+8)