如何使用DocuSign Apex Toolkit获取信封内所有文档的PDF字节流？

DevOps 小满

2026-6-20

使用DocuSign Apex Toolkit获取信封内所有文档的PDF字节流

要实现和eSign REST API等效的获取信封文档功能，你可以通过DocuSign Apex Toolkit的DsApi类直接调用底层Envelopes API方法，以下是具体实现和示例代码：

核心逻辑

初始化Apex Toolkit的API客户端，配置认证与环境信息
调用listDocuments接口获取信封内所有文档的清单
遍历文档清单，调用getDocument接口逐个提取PDF字节流

示例代码

// 初始化DocuSign API客户端
DsApi dsApi = new DsApi();
dsApi.setOAuth2ClientId('你的集成密钥'); // 替换为实际DocuSign集成密钥
dsApi.setBasePath('https://demo.docusign.net/restapi'); // 测试环境用demo，生产环境替换为https://www.docusign.net/restapi

// 目标信封ID
String targetEnvelopeId = '要查询的信封ID';

try {
    // 获取信封文档列表信息
    EnvelopeDocumentsInformation docsInfo = dsApi.EnvelopesApi.listDocuments('你的DocuSign账户ID', targetEnvelopeId);
    
    // 遍历所有文档
    for (EnvelopeDocument doc : docsInfo.getEnvelopeDocuments()) {
        // 可选：跳过证书类文档
        if (doc.getType() == 'certificate') {
            continue;
        }
        
        // 获取文档PDF字节流
        Blob docPdfBlob = dsApi.EnvelopesApi.getDocument('你的DocuSign账户ID', targetEnvelopeId, doc.getDocumentId());
        
        // 示例：将字节流保存为Salesforce附件
        Attachment newAttachment = new Attachment();
        newAttachment.Name = doc.getName() + '.pdf';
        newAttachment.Body = docPdfBlob;
        newAttachment.ParentId = '关联的Salesforce记录ID'; // 替换为实际记录ID
        insert newAttachment;
    }
} catch (DsApiException ex) {
    System.debug('获取文档出错: ' + ex.getMessage());
}