项目 | 说明 |
接口前缀 | /openapi/v1 |
传输协议 | 仅支持 HTTPS（不支持 HTTP） |
响应格式 | JSON（ Content-Type: application/json） |
字符编码 | UTF-8 |
时间格式 | RFC3339 / ISO 8601，支持时区偏移，如 2024-01-15T18:30:00+08:00 |
环境 | 域名 | 用途 |
测试环境 | https://api.test.sign.tencent.com | 开发联调 |
线上环境（新加坡节点） | https://sgapi.tencent-esign.com | 正式生产 |
https://sgapi.tencent-esign.com/openapi/v1/envelopes/quick-createHeader | 必填 | 说明 |
Authorization | 是（业务接口） | 固定格式 Bearer <access_token> |
Content-Type | 是 | 业务接口为 application/json；OAuth 接口为 application/x-www-form-urlencoded |
X-Operator-User-Id | 否 | 指定本次调用的执行身份；不传时使用应用关联的系统用户。发起合同时必须传入真实用户 ID，该用户即合同发件人 |
space_id 指定目标空间，签发的 access_token 仅对该空间有效；后续业务接口均在该空间下执行，无需再次传入 SpaceId。access_token。项目 | 内容 |
请求 URL | POST /openapi/v1/oauth/token |
Content-Type | application/x-www-form-urlencoded |
参数 | 类型 | 必填 | 说明 |
grant_type | string | 是 | 固定值 client_credentials |
client_id | string | 是 | 应用客户端 ID |
client_secret | string | 是 | 应用客户端密钥 |
space_id | string | 是 | 空间 ID |
scope | string | 是 | 权限范围，多个用空格分隔 |
POST https://sgapi.tencent-esign.com/openapi/v1/oauth/tokenContent-Type: application/x-www-form-urlencodedgrant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&space_id=YOUR_SPACE_ID&scope=envelope:create envelope:read
字段 | 说明 |
access_token | 访问令牌，有效期 1 小时 |
client_secret 必须妥善保管，切勿暴露在前端代码或公开仓库，建议使用环境变量或密钥管理服务存储。项目 | 内容 |
请求 URL | POST /openapi/v1/oauth/revoke |
Content-Type | application/x-www-form-urlencoded |
参数 | 类型 | 必填 | 说明 |
token | string | 是 | 需吊销的 access_token |
client_id | string | 是 | 应用客户端 ID |
client_secret | string | 是 | 应用客户端密钥 |
Scope | 说明 |
envelope:create | 创建并发送合同 |
envelope:read | 读取合同状态和详情 |
POST 方法，需在 Header 中携带 Authorization: Bearer <access_token>。一次完整的签署通常遵循「上传文件 → 发起合同 → 获取签署链接 → 查询结果」的顺序。FileId。项目 | 内容 |
请求 URL | POST /openapi/v1/files/upload |
参数 | 说明 |
Files | 文件列表（数组） |
Files[].FileName | 文件名 |
Files[].FileBody | Base64 编码的文件内容 |
字段 | 说明 |
FileId | 文件 ID，有效期 24 小时，需尽快用于发起合同 |
项目 | 内容 |
请求 URL | POST /openapi/v1/envelopes/quick-create |
必填 Header | Authorization、X-Operator-User-Id（发件人真实用户 ID） |
参数 | 说明 |
BasicInfo | 基本信息，含 EnvelopeTitle（合同标题）、SigningOrderType（签署顺序类型） |
Documents | 文档列表，含 DocumentId、FileId、Order |
Signers | 签署人列表，含 RecipientId、Name、Email |
Tabs | 签署位置，含 TabType、RecipientId、DocumentId、Position |
字段 | 说明 |
EnvelopeId | 合同 ID；合同创建后立即进入签署流程 |
项目 | 内容 |
请求 URL | POST /openapi/v1/envelopes/detail |
参数 | 说明 |
EnvelopeId | 合同 ID |
项目 | 内容 |
请求 URL | POST /openapi/v1/envelopes/signing-view |
参数 | 说明 |
EnvelopeId | 合同 ID |
RecipientId | 签署人 ID |
字段 | 说明 |
SignerInfos | 签署人信息列表 |
SigningUrl | 签署链接，用于发送给签署人 |
步骤 | 操作 | 方法与接口 | 关键输出 |
1 | 获取令牌 | POST /openapi/v1/oauth/token | access_token |
2 | 上传文件 | POST /openapi/v1/files/upload | FileId |
3 | 发起合同 | POST /openapi/v1/envelopes/quick-create | EnvelopeId |
4 | 获取签署链接 | POST /openapi/v1/envelopes/signing-view | SigningUrl |
5 | 下发给签署人完成签署 | - | - |
6 | 查询结果 | POST /openapi/v1/envelopes/detail | 签署状态 |
FileId 有效期 24 小时。client_secret、access_token 等敏感信息严禁出现在前端或公开代码库。文档反馈