快速开始
5 分钟完成第一次信封签署调用。
前置条件
- 已在控制台创建应用，获取
client_id和client_secret - 已获取
access_token（参见 请求鉴权） - 准备一个 PDF 文件
Step 1：上传文件
将 PDF 文件 Base64 编码后上传：
curl -X POST https://sgapi.tencent-esign.com/openapi/v1/files/upload \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"Files": [
{ "FileName": "contract.pdf", "FileBody": "<Base64编码内容>" }
]
}'返回 FileId，有效期 24 小时。
Step 2：快速发起信封
使用 FileId 组装信封并发送：
curl -X POST https://sgapi.tencent-esign.com/openapi/v1/envelopes/quick-create \
-H "Authorization: Bearer <access_token>" \
-H "X-Operator-User-Id: <用户ID>" \
-H "Content-Type: application/json" \
-d '{
"BasicInfo": {
"EnvelopeTitle": "合同签署",
"SigningOrderType": "parallel"
},
"Documents": [
{ "DocumentId": "doc1", "FileId": "<Step1返回的FileId>", "Order": 1 }
],
"Signers": [
{
"RecipientId": "r1",
"Name": "张三",
"Email": "zhangsan@example.com"
}
],
"Tabs": [
{
"TabType": "signHere",
"RecipientId": "r1",
"DocumentId": "doc1",
"Position": { "PageNumber": 1, "XPosition": 350, "YPosition": 700, "Width": 120, "Height": 40 }
}
]
}'返回 EnvelopeId，信封立即进入签署流程。
Step 3：获取签署链接
为签署人生成签署链接：
curl -X POST https://sgapi.tencent-esign.com/openapi/v1/envelopes/signing-view \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"EnvelopeId": "<Step2返回的EnvelopeId>",
"RecipientId": "r1"
}'返回 SignerInfos 列表，每项包含 SigningUrl，将该链接发给签署人即可完成签署。
Step 4：查询签署状态
curl -X POST https://sgapi.tencent-esign.com/openapi/v1/envelopes/detail \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{ "EnvelopeId": "<EnvelopeId>" }'💡
建议配置回调通知，签署完成后系统会主动推送通知，无需轮询查询。