接入流程
从创建应用到完成第一次签署调用的完整流程。
接入步骤
1. 创建应用
登录 Tencent eSign 控制台，在「应用管理」中创建应用，获取 client_id 和 client_secret。
⚠️
client_secret 仅在创建时返回一次，请立即保存到密钥管理系统或环境变量中。
2. 获取访问令牌
使用 OAuth 2.0 Client Credentials 模式换取 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成功响应：
{
"access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...",
"token_type": "Bearer",
"expires_in": 3600,
"scope": "envelope:create envelope:read"
}💡
令牌有效期 1 小时，建议缓存并在到期前约 60 秒重新申请。详见请求鉴权。
3. 配置回调地址（可选）
在控制台「回调配置」中设置 CallbackUrl，系统将在信封状态变更时主动推送通知。
4. 开始调用 API
携带 access_token 调用业务接口：
上传文件 → 创建并发送信封 → 获取签署链接 → 查询签署状态💡
建议先在测试环境完成全流程验证后再切换到生产环境。
典型调用时序
客户系统 Tencent eSign 平台
│ │
│─── 0. 获取令牌 ───────────────→│ POST /openapi/v1/oauth/token
│←── 返回 access_token ────────│
│ │
│─── 1. 上传文件 ───────────────→│ POST /openapi/v1/files/upload
│←── 返回 FileId ──────────────│
│ │
│─── 2. 创建并发送信封 ─────────→│ POST /openapi/v1/envelopes
│←── 返回 EnvelopeId ─────────│
│ │
│─── 3. 获取签署链接 ──────────→│ POST /openapi/v1/envelopes/{envelopeId}/signing-url
│←── 返回 SigningUrl ──────────│
│ │
│ （接收人完成签署） │
│ │
│←── 4. 回调通知（签署完成）────│ POST 你的 CallbackUrl
│ │
│─── 5. 查询信封详情 ──────────→│ POST /openapi/v1/envelopes/detail
│←── 返回完整签署状态 ─────────│