开始使用请求鉴权

请求鉴权

所有业务 API 请求须携带 OAuth 2.0 访问令牌进行身份认证。

认证方式

所有业务接口须在 HTTP Header 中携带 Bearer Token:

Authorization: Bearer <access_token>

获取 access_token

Tencent eSign Open API 使用 OAuth 2.0 Client Credentials 授权模式。使用应用的 client_idclient_secret 向令牌端点换取 access_token

POST https://sgapi.tencent-esign.com/openapi/v1/oauth/token
Content-Type: application/x-www-form-urlencoded
 
grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET&space_id=YOUR_SPACE_ID&scope=envelope:create envelope:read
⚠️

请妥善保管 client_secret,不要暴露在前端代码或公开仓库中。建议使用环境变量或密钥管理服务存储。

💡

access_token 有效期为 1 小时,建议缓存令牌并在到期前约 60 秒重新申请,避免频繁请求令牌端点。

完整的请求参数、响应参数及错误码说明,请参阅 令牌端点 API 文档

吊销 access_token

当不再需要某个令牌时,可以主动吊销使其立即失效。

POST https://sgapi.tencent-esign.com/openapi/v1/oauth/revoke
Content-Type: application/x-www-form-urlencoded
 
token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET

完整的请求参数及响应说明,请参阅 令牌吊销端点 API 文档

Scope 权限

当前支持的 scope:

Scope说明
envelope:create创建并发送信封
envelope:read读取信封状态和详情

多个 scope 用空格分隔,如:envelope:create envelope:read

业务接口公共请求头

获取到 access_token 后,调用业务接口时需携带以下请求头:

Authorization必填string
Bearer <access_token>
Content-Type必填string
application/json
X-Operator-User-Id选填string
操作用户 ID(不填时使用系统用户 ID)
ℹ️

以上请求头仅适用于业务接口。OAuth 令牌端点(获取/吊销令牌)使用 application/x-www-form-urlencoded 格式,不需要 Authorization 头。

错误响应

令牌端点的错误响应遵循 RFC 6749 §5.2 格式,详见 令牌端点 API 文档