如何通过DocuSign CLM API提取存于CLM文件夹的合同文档元数据？

一、通过DocuSign CLM API实现 #

完全可以利用DocuSign CLM API提取合同文档的元数据，具体操作如下：

• 获取文件夹内文档列表：调用GET /folders/{folderId}/documents端点，传入目标文件夹ID，可获取该文件夹下所有文档的基础元数据，包括文档ID、名称、创建时间、所有者、状态等。
• 获取文档详细元数据：针对第一步拿到的文档ID，调用GET /documents/{documentId}端点，能获取更完整的元数据，比如自定义字段值、审批流程记录、关联业务实体信息等。
• 权限要求：确保API账号拥有目标文件夹及文档的读取权限，需提前在CLM后台配置对应角色权限（如文档查看者、管理员）。
• 示例代码片段：

  import requests
  
  # 配置CLM域名和访问令牌
  clm_domain = "your-clm-instance-domain.com"
  access_token = "your-api-access-token"
  folder_id = "target-folder-id"
  
  # 获取文件夹下的文档列表
  folder_docs_url = f"https://{clm_domain}/api/v2/folders/{folder_id}/documents"
  headers = {"Authorization": f"Bearer {access_token}"}
  docs_response = requests.get(folder_docs_url, headers=headers)
  documents = docs_response.json()
  
  # 遍历获取每个文档的详细元数据
  for doc in documents:
      doc_detail_url = f"https://{clm_domain}/api/v2/documents/{doc['id']}"
      meta_response = requests.get(doc_detail_url, headers=headers)
      doc_metadata = meta_response.json()
      # 按需处理元数据（比如存储到本地或内部系统）
      print(f"文档{doc['name']}元数据：{doc_metadata}")
  

二、替代方案 #

如果不使用API，还有以下几种可行方式：

• CLM网页端导出：登录CLM网页界面，进入目标文件夹，选中需要的文档，点击导出选项（支持CSV格式），可直接下载包含基础元数据的表格，适合快速提取数据的非技术场景。
• 自定义报告生成：利用CLM内置的报告模块，创建自定义报告，选择需要展示的元数据字段（如文档名称、创建日期、审批状态、自定义属性等），生成后可下载或直接查看，灵活性较高。
• Webhook同步至内部系统：配置CLM的webhook，当文档状态更新或元数据变更时，自动同步到内部CRM、数据库等系统，后续可从内部系统提取和分析元数据，适合长期的自动化数据集成需求。

内容的提问来源于stack exchange，提问作者Sushant Patekar