首页 / 博客中心 / DocuSign API:如何从已签名的文档中获取“Tab Data”(表单数据)?

DocuSign API:如何从已签名的文档中获取“Tab Data”(表单数据)?

顺访
2026-01-18
3min
Twitter Facebook Linkedin

导航 DocuSign API 以提取表单数据:商业视角

在数字协议不断演变的格局中,企业越来越依赖电子签名平台如 DocuSign 来简化工作流程并确保合规性。随着组织规模的扩大,集成 DocuSign 的 API 对于自动化从已签名文档中提取数据变得至关重要。本文探讨如何使用 DocuSign 的 API 检索“Tab Data”——签署过程中填充的表单字段——为开发者和商业领导者提供实用见解。从商业角度来看,掌握此功能可以降低手动处理成本并提升数据分析能力,但需要理解 API 限制和最佳实践,以避免集成陷阱。

Top DocuSign Alternatives in 2026


正在比较带有 DocuSign 或 Adobe Sign 的电子签名平台?

eSignGlobal 提供更灵活且成本效益更高的电子签名解决方案,具有全球合规性、透明定价和更快的入职流程。

👉 开始免费试用


DocuSign 中的 Tab Data 是什么?

Tab Data 指的是 DocuSign 信封中表单字段(或“标签”)捕获的结构化信息,例如由签名者添加的文本框、复选框、日期或签名。一旦文档被签署,此数据代表完成的表单值,对于 CRM 更新、合规报告或发票生成等业务流程至关重要。在 DocuSign 的生态系统中,标签通过平台的创作工具嵌入 PDF 文档中,并在完成后的服务器端存储其值。

从商业观察来看,通过 API 提取 Tab Data 对于处理高容量协议的企业来说是一个变革性的功能。它使与 Salesforce 或 ERP 系统等工具的无缝集成成为可能,可能将数据输入时间缩短 70-80%。然而,信封状态(例如,已作废或已拒绝)和数据序列化等方面的挑战可能会使检索复杂化,如果处理不当。

逐步指南:使用 DocuSign API 从已签名文档中检索 Tab Data

要在签署后访问 Tab Data,您将使用 DocuSign 的 REST API(推荐使用 2.1 版以确保 2025 年的稳定性)。此过程假设您拥有开发者账户、API 凭据(集成密钥、密钥和用户 ID)以及一个活跃的信封。API 端点通过 OAuth 2.0 进行安全保护,确保符合 ESIGN 和 eIDAS 等标准。

先决条件和设置

  1. 获取 API 访问权限:登录 DocuSign 开发者中心(developer.docusign.com)并创建应用。生成集成密钥并启用 JWT 或 Auth Code Grant 以进行身份验证。对于生产环境,从沙箱切换到实时凭据。

  2. 识别信封:确保信封处于“Completed”状态。使用 GET /envelopes/{envelopeId} 端点进行验证:

    curl -X GET "https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}" \
    -H "Authorization: Bearer {accessToken}"
    

    这将返回信封详细信息,包括状态。

  3. 身份验证:实施 OAuth。对于 JWT,使用您的私钥生成令牌:

    import requests
    from docusign_esign import ApiClient, EnvelopesApi
    
    api_client = ApiClient()
    api_client.host = "https://demo.docusign.net/restapi"
    api_client.request_header['Authorization'] = 'Bearer ' + access_token  # 来自 JWT 流程
    

商业提示:在高风险环境中,使用企业计划以获得更高的 API 配额(高级层自定义限制最高,起始价格为每年 5,760 美元),因为免费开发者沙箱每月上限为 25 个信封。

检索 Tab Data:核心 API 调用

关键端点是 GET /envelopes/{envelopeId}/documents/{documentId}/form_data,但对于全面的 Tab Data,请将其与信封收件人和自定义字段结合使用。以下是工作流程:

  1. 列出信封中的文档: 首先获取文档 ID,因为 Tab Data 与特定 PDF 相关联。

    curl -X GET "https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents" \
    -H "Authorization: Bearer {accessToken}"
    

    响应包括 documentId(例如,主要 PDF 的 1)。

  2. 提取表单数据(标签值): 使用表单数据端点获取所有填充的标签:

    curl -X GET "https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/form_data" \
    -H "Authorization: Bearer {accessToken}"
    

    示例响应(JSON):

    {
      "formData": [
        {
          "name": "customerName",
          "value": "John Doe",
          "pageNumber": 1,
          "xPosition": 100,
          "yPosition": 200,
          "width": 150,
          "height": 20
        },
        {
          "name": "signatureDate",
          "value": "2025-01-15",
          "recipient": "Signer1"
        }
      ]
    }
    

    这会捕获文本、日期和其他字段值。请注意:签名本身不是“数据”,但可以通过 recipientId 引用。

  3. 处理特定收件人的数据: 对于多签名者信封,使用 GET /envelopes/{envelopeId}/recipients/{recipientId}/tabs 按收件人过滤。这将返回分配给该签名者的标签:

    curl -X GET "https://demo.docusign.net/restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs" \
    -H "Authorization: Bearer {accessToken}"
    

    响应包括 tabLabel(匹配您的表单字段名称)和 value

  4. 高级:自定义字段和附件: 如果使用 Business Pro 功能如签名者附件,请通过 GET /envelopes/{envelopeId}/custom_fields 检索。对于完整审计跟踪(与合规相关),在信封查询中附加 ?include=summary

代码实现(Python 示例)

使用 DocuSign eSign SDK:

from docusign_esign import EnvelopesApi, EnvelopeFormData

envelopes_api = EnvelopesApi(api_client)
envelope_id = 'your-envelope-id'
account_id = 'your-account-id'
document_id = 1  # 主要文档

# 获取表单数据
form_data_result = envelopes_api.get_form_data(account_id, envelope_id, document_id=document_id)
for fd in form_data_result.form_data:
    print(f"Field: {fd.name}, Value: {fd.value}")

此脚本输出所有 Tab Data,准备导出到 CSV 或插入数据库。

常见挑战和最佳实践

  • 错误处理:API 速率限制(例如,中级计划每小时 1,000 次调用,每年 3,600 美元)可能会限制大型查询。实施带有指数退避的重试机制。
  • 数据隐私:通过在检索后掩码敏感字段,确保 GDPR/eIDAS 合规性。
  • 测试:使用沙箱信封模拟签名而无需成本。对于批量场景,利用 Connect Webhooks 在完成事件上触发数据拉取,减少轮询开销。
  • 成本影响:API 调用计入信封配额(例如,标准计划每月 100 个,每用户每年 300 美元)。超额将产生计量费用,因此通过 API 使用中心监控。

从商业角度来看,此 API 集成可以通过自动化产生 ROI——企业报告合同周期加快 50%——但需要前期开发者时间(稳健设置需 2-4 周)。对于企业,DocuSign 的高级 API 层(每年 5,760 美元)解锁批量发送和 webhook 功能,适合扩展。

DocuSign 的更广泛产品套件

DocuSign 超越核心电子签名,提供如 Intelligent Agreement Management (IAM) 等工具,该工具集成合同生命周期管理 (CLM) 以实现端到端工作流程。IAM CLM 自动化起草、谈判和存储,将 Tab Data 拉入分析仪表板进行风险评估。定价从增强计划的自定义开始,强调 SSO 和大型团队的治理。

image

竞争格局:电子签名平台比较

在价值超过 50 亿美元的电子签名市场中,DocuSign 以强大的 API 能力领先,但替代方案在定价、合规性和区域焦点方面提供不同的优势。以下是基于 2025 年公开数据的关键玩家的中立比较。

DocuSign 概述

DocuSign 在全球占据主导地位,具有全面的 API 支持 Tab Data 提取,如前所述。其优势在于企业级功能,如批量发送和身份验证附加组件(计量费用)。然而,基于座位的定价对于大型团队可能会急剧上升,并且亚太地区的延迟可能影响性能。

Adobe Sign 概述

Adobe Sign 与 Adobe Acrobat 生态系统集成,通过其 REST API(例如,GET /agreements/{agreementId}/formData)提供类似表单数据访问。它因无缝 PDF 处理和企业安全而受到赞誉,个人计划起始价格为每月 10 美元/用户。缺点包括高级自动化成本更高,以及与 DocuSign 相比自定义工作流程的灵活性较低。

image

eSignGlobal 概述

eSignGlobal 将自身定位为合规替代方案,支持全球超过 100 个主流国家的电子签名。它在亚太地区表现出色,该地区电子签名法规碎片化、高标准且严格监管——通常需要生态系统集成的途径,如与政府数字身份的深度硬件/API 对接(G2B)。与美欧依赖电子邮件验证或自我声明的框架式 ESIGN/eIDAS 标准不同,亚太地区需要本地集成以确保法律有效性。eSignGlobal 的 Essential 计划以每年 299 美元(约每月 24.9 美元,尽管促销定价可降至相当于每月 16.6 美元)提供强大价值,允许最多 100 个签名文档、无限用户座位,并通过访问代码验证。它无缝集成香港的 iAM Smart 和新加坡的 Singpass,使其成为无需额外费用的区域合规理想选择。在全球范围内,包括美国和欧盟,eSignGlobal 通过在成本上低于竞争对手的同时保持如 API 驱动表单数据检索等功能来竞争。

esignglobal HK


正在寻找比 DocuSign 更智能的替代方案?

eSignGlobal 提供更灵活且成本效益更高的电子签名解决方案,具有全球合规性、透明定价和更快的入职流程。

👉 开始免费试用


HelloSign (Dropbox Sign) 和其他竞争对手

HelloSign,现为 Dropbox Sign,提供用于表单字段提取的简单 API(通过 GET /signature_request/{request_id}/details),针对小型团队提供免费层。它对 SMB 友好,但缺乏 DocuSign 在自动化方面的深度。其他玩家如 PandaDoc 专注于带有嵌入表单的提案,而 SignNow 强调移动优先体验。

功能/方面 DocuSign Adobe Sign eSignGlobal HelloSign (Dropbox Sign)
表单数据提取 API 强大(REST v2.1,标签端点) 强大(协议 API) 包含在 Pro 计划中,支持 webhook 基础(签名详情 API)
定价模型(入门级) 每月 10 美元(个人,5 个信封) 每月 10 美元/用户 每年 299 美元(无限用户,100 个文档) 免费(每月 3 个文档),付费每月 15 美元
合规焦点 全球(ESIGN, eIDAS) 企业(GDPR, HIPAA) 100+ 国家,亚太深度(iAM Smart, Singpass) 主要美国/欧盟
用户座位 按座位计费 按用户 无限 付费计划中无限
优势 企业集成,批量发送 PDF 生态系统 成本效益,区域合规 简单性,Dropbox 集成
限制 扩展成本更高 设置复杂 西部品牌知名度较低 高级自动化有限

此表格突出了权衡:DocuSign 注重深度,eSignGlobal 注重亚太效率。

最终思考:选择合适的方案

对于优先考虑 API 驱动数据提取的企业,DocuSign 仍是可靠选择,因为其成熟生态系统。然而,随着区域需求增长——特别是在合规密集领域——替代方案如 eSignGlobal 为寻求成本节省和本地化支持的 DocuSign 用户提供平衡且区域优化的选项。根据您的容量和地理位置进行评估。

常见问题

如何使用 DocuSign API 从已签名的文档中检索标签数据?
要检索标签数据(表示签署过程中输入的表单字段值),请使用 DocuSign REST API 的 Envelopes API。首先,在完成签署后获取信封 ID。然后,向端点 /envelopes/{envelopeId}/documents/{documentId}/form_data 发送 GET 请求。这将根据指定的 Accept 标头以 XML 或 JSON 格式返回标签数据。请确保您具有必要的权限并通过 OAuth 进行身份验证。对于具有增强合规性需求的亚洲运营,eSignGlobal 提供合适的替代方案。
DocuSign API 中标签数据响应的结构是什么?
通过 DocuSign API 获取标签数据时会出现哪些常见问题,以及如何解决它们?
avatar
顺访
eSignGlobal 产品管理负责人,在电子签名产业拥有丰富国际经验的资深领导者 关注我的LinkedIn
立即获得具有法律约束力的签名!
30天免费全功能试用
企业电子邮箱
开始
tip 仅允许使用企业电子邮箱