如何使用DocuSign API下载已签署文档及请求体说明

前置准备 #

你需要先获取以下信息：

• DocuSign 开发者账户（沙箱/生产环境均可）
• 集成密钥（API密钥）
• 账户ID（可在DocuSign控制台的「我的账户」页面查看）
• 目标签署完成的信封ID（envelopeId）
• 有效的访问令牌（通过OAuth2授权码流或JWT流获取）

核心API调用 #

使用DocuSign Envelopes API的getDocument接口，支持单文档下载或全文档压缩包下载。

1. 下载单个文档 #

接口地址：

GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}

参数说明：

• accountId：你的DocuSign账户ID
• envelopeId：目标信封的唯一ID
• documentId：文档ID（通常1对应主签署文档，certificate对应签署证书）

cURL请求示例

curl --request GET \
  --url https://demo.docusign.net/restapi/v2.1/accounts/123456/envelopes/7890abcdef/documents/1 \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Accept: application/pdf' \
  --output signed_document.pdf

注：--output参数用于直接将响应保存为本地文件

2. 下载所有文档的压缩包 #

将documentId替换为archive，即可获取包含所有签署文档、证书及附件的ZIP包：

curl --request GET \
  --url https://demo.docusign.net/restapi/v2.1/accounts/123456/envelopes/7890abcdef/documents/archive \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Accept: application/zip' \
  --output all_documents.zip

请求参数说明 #

该接口为GET请求，无需请求体，但可通过查询参数扩展功能：

• include_attachments：布尔值，设为true时会包含信封中的附件，默认false
• encoding：指定返回格式，可选base64（返回Base64编码的文档内容），默认返回二进制流
• certificate：当documentId为1时，设为true会在主文档末尾附加签署证书，默认false

带查询参数的示例

curl --request GET \
  --url https://demo.docusign.net/restapi/v2.1/accounts/123456/envelopes/7890abcdef/documents/1?include_attachments=true&certificate=true \
  --header 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...' \
  --header 'Accept: application/pdf' \
  --output signed_doc_with_cert.pdf

响应处理 #

• 成功响应：返回对应格式的二进制文件（PDF/ZIP），状态码200 OK
• 常见错误：
  • 401 Unauthorized：访问令牌过期或无效，需重新获取
  • 404 Not Found：信封ID或文档ID不存在，检查参数是否正确
  • 403 Forbidden：无权限访问该信封，确认账户权限及信封归属

内容的提问来源于stack exchange，提问作者Prakash N