
本教程旨在解决php docusign集成中,使用getdocument方法下载已完成签署的文档时,文件内容为空的问题。我们将深入探讨导致此问题的sdk版本缺陷,并提供两种有效的解决方案:推荐升级docusign php sdk至最新版本(6.5.1及以上),以及针对sdk 6.5版本的临时兼容性代码,通过正确处理splfileobject的文件指针来确保文档内容被正确读取和保存。
在将DocuSign集成到PHP Laravel应用程序中,并成功实现JWT认证、发送信封以供签署后,下一步通常是下载已完成签署的文档,包括完整的CoC(Certificate of Completion)。然而,在尝试检索这些文档时,开发者可能会遇到一个常见问题:下载的文件内容为空。
当使用DocuSign PHP SDK的EnvelopesApi中的getDocument方法来获取特定信封的已签署文档时,通常会得到一个SplFileObject实例,它指向一个临时文件。开发者可能会尝试通过以下方式将该临时文件内容保存到本地:
use DocuSign\eSign\Api\EnvelopesApi;
use DocuSign\eSign\Client\ApiClient;
// 假设 $apiClient, $account_id, $envelope_id 已经正确初始化
$envelope_api = new EnvelopesApi($apiClient);
// 获取文档,'combined' 表示获取所有文档的合并版本
$tmpFile = $envelope_api->getDocument($account_id, 'combined', $envelope_id);
// 尝试保存文件,但可能导致下载的PDF为空
$savCert = file_put_contents("signed_document.pdf", file_get_contents($tmpFile->getPathname()));尽管$tmpFile是一个有效的SplFileObject实例,并且其getPathname()方法返回了一个指向临时文件的路径(例如C:\Users\AppData\Local\Temp\19F.tmp),但最终保存的signed_document.pdf文件却是空的。
此问题通常是由于DocuSign PHP SDK的特定版本(例如6.5版本)中存在一个已知错误。在该版本中,getDocument方法返回的SplFileObject实例在创建后,其内部文件指针可能没有被重置到文件的起始位置。当file_get_contents()函数尝试读取$tmpFile->getPathname()指向的临时文件时,如果文件指针已位于文件末尾,它将无法读取任何内容,从而导致保存的文档为空。
立即学习“PHP免费学习笔记(深入)”;
解决此问题有两种主要方法:推荐的SDK升级和针对特定版本的临时兼容性代码。
最直接且推荐的解决方案是将DocuSign PHP SDK更新到修复了此问题的版本。根据官方信息,SDK 6.5.1及更高版本已经包含了此修复。
通过Composer更新SDK非常简单:
composer update docusign/esign-client
执行此命令后,Composer将检查并安装docusign/esign-client包的最新兼容版本。更新完成后,之前的代码应该能够正常工作,无需额外修改。
如果由于项目限制无法立即升级SDK到最新版本(例如,依赖项冲突或其他兼容性问题),可以采用以下临时兼容性代码来解决SDK 6.5版本中的问题。此方法通过手动重置SplFileObject的文件指针并读取其内容来绕过缺陷。
use DocuSign\eSign\Api\EnvelopesApi;
use DocuSign\eSign\Client\ApiClient;
use SplFileObject; // 确保引入 SplFileObject
// 假设 $apiClient, $account_id, $envelope_id 已经正确初始化
$envelopeApi = new EnvelopesApi($apiClient);
// 获取文档
/** @var SplFileObject $tmpFile */
$tmpFile = $envelopeApi->getDocument($account_id, 'combined', $envelope_id);
// 检查 $tmpFile 是否是 SplFileObject 实例
if ($tmpFile instanceof SplFileObject) {
// 关键步骤:重置文件指针到文件开头
$tmpFile->rewind();
// 读取文件的全部内容
// fstat()['size'] 获取文件大小,确保读取所有内容
$contents = $tmpFile->fread($tmpFile->fstat()['size']);
// 将内容保存到本地文件
$savCert = file_put_contents("signed_document.pdf", $contents);
if ($savCert !== false) {
echo "文档已成功保存为 signed_document.pdf\n";
} else {
echo "文档保存失败。\n";
}
} else {
echo "获取文档失败,返回的不是 SplFileObject 实例。\n";
}代码解释:
以下是一个结合了DocuSign客户端初始化和文档下载的完整示例:
<?php
require_once(__DIR__ . '/vendor/autoload.php'); // 假设您的 Composer autoload 文件在此处
use DocuSign\eSign\Api\EnvelopesApi;
use DocuSign\eSign\Client\ApiClient;
use DocuSign\eSign\Client\Auth\OAuth;
use DocuSign\eSign\Configuration;
use DocuSign\eSign\Model\EnvelopeDefinition;
use DocuSign\eSign\Model\Signer;
use DocuSign\eSign\Model\RecipientViewRequest;
use SplFileObject;
// --- 配置 DocuSign 客户端 ---
// 请替换为您的实际凭据
$integratorKey = 'YOUR_INTEGRATOR_KEY';
$userId = 'YOUR_USER_ID'; // 通常是DocuSign账户管理员的GUID
$rsaPrivateKey = file_get_contents('YOUR_PRIVATE_KEY.pem'); // 私钥文件路径
$apiHost = 'https://demo.docusign.net/restapi'; // 沙箱环境,生产环境请使用 'https://www.docusign.net/restapi'
$config = new Configuration();
$config->setHost($apiHost);
$apiClient = new ApiClient($config);
try {
// JWT 认证
$oauth = new OAuth();
$oauth->setAccessToken($apiClient->generateJWTUserToken($integratorKey, $userId, $rsaPrivateKey, $apiHost, 3600));
$config->setAccessToken($oauth->getAccessToken());
// 获取账户信息以获取 account_id
$account = $apiClient->getUserInfo($oauth->getAccessToken())->getAccounts()[0];
$account_id = $account->getAccountId();
echo "DocuSign 认证成功,Account ID: " . $account_id . "\n";
// --- 假设您已经有一个信封ID ---
// 替换为您的实际已完成签署的信封ID
$envelope_id = 'YOUR_COMPLETED_ENVELOPE_ID';
// 初始化 EnvelopesApi
$envelopeApi = new EnvelopesApi($apiClient);
echo "正在尝试下载信封 ID: " . $envelope_id . " 的已签署文档...\n";
/** @var SplFileObject $tmpFile */
$tmpFile = $envelopeApi->getDocument($account_id, 'combined', $envelope_id);
if ($tmpFile instanceof SplFileObject) {
// 方案二:SDK 6.5 兼容性代码
// 如果您已升级SDK到 6.5.1+,可以删除以下三行
$tmpFile->rewind();
$contents = $tmpFile->fread($tmpFile->fstat()['size']);
$filePath = "signed_document_" . $envelope_id . ".pdf";
$savCert = file_put_contents($filePath, $contents);
// 如果已升级SDK到 6.5.1+,则直接使用以下代码
// $filePath = "signed_document_" . $envelope_id . ".pdf";
// $savCert = file_put_contents($filePath, file_get_contents($tmpFile->getPathname()));
if ($savCert !== false) {
echo "文档已成功保存为 " . $filePath . ",大小:" . round($savCert / 1024, 2) . " KB\n";
} else {
echo "文档保存失败。\n";
}
} else {
echo "获取文档失败,返回的不是 SplFileObject 实例。\n";
}
} catch (\DocuSign\eSign\Client\ApiException $e) {
echo "DocuSign API 错误: " . $e->getMessage() . "\n";
// 打印更详细的错误信息
if ($e->getResponseBody()) {
echo "Response Body: " . $e->getResponseBody() . "\n";
}
} catch (Exception $e) {
echo "一般错误: " . $e->getMessage() . "\n";
}
?>注意事项:
当在PHP DocuSign集成中遇到下载已签署文档为空的问题时,最常见的根源是DocuSign PHP SDK 6.5版本中的一个bug,它导致SplFileObject的文件指针未正确重置。解决此问题的最佳实践是升级SDK到6.5.1或更高版本。如果无法立即升级,则可以使用手动重置SplFileObject文件指针(rewind())并读取其内容(fread())的兼容性代码作为临时解决方案。理解文件流操作的原理对于调试此类问题至关重要,同时保持SDK的最新状态是确保集成稳定性和安全性的关键。
以上就是PHP DocuSign集成:解决下载已签署文档为空的问题的详细内容,更多请关注php中文网其它相关文章!
PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号