DocuSign API：如何获取特定文件夹中所有模板的列表？

DocuSign 模板和 API 介绍

在数字文档管理不断演变的格局中，DocuSign 作为领先的电子签名平台脱颖而出，它为全球企业简化了工作流程。模板在 DocuSign 中发挥着关键作用，允许用户标准化文档以供重复使用，从而节省时间并确保合同审批或入职等流程的一致性。DocuSign API 使开发者能够以编程方式自动化这些任务，便于将电子签名功能集成到自定义应用程序中。本文探讨如何利用 DocuSign API 从特定文件夹中检索所有模板列表，这是企业环境中高效模板管理的一个常见需求。

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

eSignGlobal 提供更灵活且性价比更高的电子签名解决方案，具备全球合规性、透明定价和更快的入职流程。

👉 开始免费试用

理解 DocuSign 模板

DocuSign 模板是预配置的文档，其中包含预定义字段、签名者角色和工作流程。它们在 DocuSign 账户中组织成文件夹，使用户能够按部门、项目或类型对它们进行分类——例如，将 HR 模板放在一个文件夹中，将销售协议放在另一个文件夹中。这种组织对于处理大量文档的团队至关重要，因为它可以防止杂乱并便于快速访问。

从业务角度来看，模板可以减少错误并加速签名流程。例如，销售团队可以重复使用提案模板，而无需每次重新创建字段，从而确保品牌一致性和合规性。然而，对于拥有数百个模板的大型账户，手动浏览文件夹可能效率低下。这就是 DocuSign API 的用武之地，它提供了一种编程方式来查询和列出模板。

DocuSign API 入门

要使用 DocuSign API，开发者需要一个活跃的 DocuSign 账户和 API 凭据。DocuSign 提供了一个免费的沙盒环境用于测试，该环境镜像生产功能。认证通常涉及 OAuth 2.0，您可以从 DocuSign 开发者中心生成集成密钥（客户端 ID）和密钥。

模板的关键端点位于 eSignature API 下，具体为 /accounts/{accountId}/templates 资源。您需要账户 ID，可以通过 /accounts 端点获取。DocuSign 中的文件夹由唯一的文件夹 ID 标识，这些 ID 可以使用 /folders 端点检索。这种设置确保了对模板数据的安全、可扩展访问。

DocuSign 的 API 文档全面，支持 Java、.NET、PHP 和 Python 等语言的 SDK，简化了集成。对于企业而言，这意味着可以将电子签名嵌入 CRM 系统（如 Salesforce）或自定义应用程序中，从而提升运营效率，而无需切换工具。

如何使用 DocuSign API 从特定文件夹检索模板

使用 DocuSign REST API 从特定文件夹检索模板列表是一个简单过程。此功能对于需要动态填充模板选项或审计文件夹内容的应用程序特别有用。核心端点是 GET /accounts/{accountId}/folders/{folderId}/templates，它返回指定文件夹中模板的分页列表。

先决条件

在深入代码之前，请确保：

• 您拥有 OAuth 2.0 访问令牌。
• 已知账户 ID 和文件夹 ID。要获取文件夹 ID，首先调用 GET /accounts/{accountId}/folders 以列出所有文件夹并识别您需要的文件夹（例如，按名称或共享状态）。
• 权限：API 用户必须具有模板读取访问权限。

逐步实施

1. 认证并获取令牌： 使用 OAuth 流程获取访问令牌。例如，在 Python 中使用 DocuSign eSignature SDK：

   import docusign_esign as ds_esign
   
   # 配置 API 客户端
   api_client = ds_esign.ApiClient()
   api_client.host = 'https://demo.docusign.net/restapi'  # 测试时使用 demo
   api_client.set_default_header('Authorization', 'Bearer ' + access_token)
   

2. 检索文件夹 ID： 如果文件夹 ID 未知，请列出文件夹：

   envelopes_api = ds_esign.EnvelopesApi(api_client)
   folders = envelopes_api.list_folders(account_id)
   # 迭代查找按名称的文件夹，例如 folder_id = next(f['folderId'] for f in folders if f['folderName'] == 'My Templates Folder')
   

3. 列出文件夹中的模板： 使用 Templates API 获取模板：

   templates_api = ds_esign.TemplatesApi(api_client)
   template_list = templates_api.list_templates(account_id, folder=folder_id, count=100)  # 调整 count 以进行分页
   for template in template_list.envelopes:
       print(f"Template Name: {template.name}, ID: {template.template_id}")
   

   这将返回模板名称、ID、共享状态和最后修改日期等详细信息。响应为 JSON 格式，其中包含模板摘要的 envelopes 数组。

4. 处理分页和错误： 如果文件夹中的模板超过指定数量（默认 20，最大 100），请使用 start_position 查询参数获取后续页面。常见错误包括 401（未授权）或 404（文件夹未找到）——始终包含错误处理：

   try:
       template_list = templates_api.list_templates(account_id, folder=folder_id)
   except ds_esign.ApiException as e:
       print(f"Error: {e.body}")
   

5. 高级过滤： 添加查询参数，如 search_text 以按名称过滤，或 include 以包含共享模板。对于企业用户，这与网络钩子集成良好，用于模板更改时的实时更新。

此 API 调用通常只需毫秒时间，非常适合 UI 驱动的应用程序，其中用户从文件夹模板下拉列表中选择。企业报告，通过自动化模板发现，文档准备时间可节省高达 50%。

示例用例

想象一家律师事务所将 DocuSign 与其案件管理系统集成。API 从“Contracts”文件夹中拉取模板，根据案件类型自动填充，从而确保合规性和速度。

通过 API 管理模板的最佳实践

在实施此 API 功能时，请优先考虑安全性，使用 JWT 或授权码授权来获取令牌，并定期轮换它们。使用缓存限制 API 调用以避免速率限制（例如，生产环境中每小时 1,000 次调用）。为实现可扩展性，请使用 DocuSign 的 Connect 网络钩子来通知您的应用程序新模板，而无需轮询。

通过 API 仪表板监控使用情况，以跟踪信封配额，因为模板在 Business Pro 等计划中会计入整体限制。在沙盒中测试可以防止生产中断。

与竞争对手比较 DocuSign

DocuSign 是一个强大的电子签名平台，提供无缝 API 集成和全球合规性。其模板管理在结构化环境中表现出色，但定价会随着用户和功能而扩展。

Adobe Sign 现为 Adobe Document Cloud 的一部分，提供与 Adobe 生态系统的强大集成，如 PDF 编辑。它对创意团队友好，但高级 API 使用可能需要额外许可。

eSignGlobal 作为竞争性替代方案脱颖而出，尤其在亚太（APAC）地区。它支持全球 100 个主流国家的合规性，特别强调 APAC 碎片化的监管格局。与美国（ESIGN）或欧洲（eIDAS）的基于框架的标准不同，后者依赖电子邮件验证或自我声明，APAC 法规要求生态系统集成的解决方案——与政府数字身份（G2B）的深度硬件和 API 级集成。这包括高标准和严格监督，将技术壁垒提高到远高于西方模式的水平。eSignGlobal 在此领域表现出色，提供与香港 iAM Smart 和新加坡 Singpass 的无缝集成，同时具备无限用户和性价比高的定价。其 Essential 计划仅需每月 16.6 美元，允许发送多达 100 个电子签名文档、无限用户席位，并通过访问代码验证，在合规基础上提供高价值。这使 eSignGlobal 能够与 DocuSign 和 Adobe Sign 在全球竞争，通常以更低的成本。

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

eSignGlobal 提供更灵活且性价比更高的电子签名解决方案，具备全球合规性、透明定价和更快的入职流程。

👉 开始免费试用

HelloSign（现为 Dropbox Sign）专注于简单性，提供直观的模板和适合小团队的 API 访问。它对基本需求性价比高，但缺乏一些企业级功能。

此表格突出了中性权衡：DocuSign 用于规模，Adobe 用于集成，eSignGlobal 用于区域价值，HelloSign 用于易用性。

结论

导航 DocuSign 的 API 以进行模板管理可以显著提升生产力，尤其是在特定文件夹查询方面。对于寻求替代方案的企业，eSignGlobal 在 APAC 及更广泛地区提供坚实、区域合规的选择。