开始使用调用方式

调用方式

所有 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

请求方法与内容类型

接口类型方法请求 Content-Type
业务接口(上传文件、创建信封等)POSTapplication/json
OAuth 令牌端点(获取/吊销令牌)POSTapplication/x-www-form-urlencoded

业务接口的请求参数通过 JSON Body 传递;OAuth 令牌端点的参数通过表单字段传递,详见请求鉴权

操作用户

应用创建时会自动关联一个系统用户 ID。可通过 Header X-Operator-User-Id 指定本次调用的执行身份,不传时系统自动使用该系统用户 ID。

⚠️

创建并发送信封接口(CreateEnvelope)要求传入真实用户 ID,该用户将作为信封发件人。

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)