如何通过PHP调用DocuSign API使用本地指定文件创建模板？

我之前帮不少开发者搞定过类似的需求，其实用DocuSign官方的PHP SDK来实现这个并不复杂，我给你拆解成具体的步骤，跟着做就能搞定：

1. 前期准备 #

• 确保你已经拥有DocuSign开发者账号，创建好集成密钥（Integrator Key），并获取到你的账户ID（Account ID）。
• 用Composer安装DocuSign官方PHP SDK，在项目根目录执行命令：

  composer require docusign/esign-client
  

• 准备好认证令牌：如果是服务器端无交互场景，用JWT认证提前配置好密钥对并获取令牌；如果是用户授权场景，先拿到OAuth授权码对应的访问令牌。

2. 处理本地DOCX文件 #

你需要把本地路径C:\workspace\myfiles\file.docx的文件转换成base64编码的字节流，这是DocuSign API接受的文件格式。PHP里用file_get_contents()就能轻松处理，注意路径的正确性——Windows下的反斜杠可以直接使用，或者转成正斜杠也没问题。

3. 核心代码实现 #

下面是完整的可运行示例代码，每一步都加了注释说明：

<?php
require __DIR__ . '/vendor/autoload.php';

use DocuSign\eSign\Client\ApiClient;
use DocuSign\eSign\Configuration;
use DocuSign\eSign\Model\Template;
use DocuSign\eSign\Model\Document;
use DocuSign\eSign\Model\TemplateRole;
use DocuSign\eSign\Api\TemplatesApi;

// 1. 配置API客户端
$config = new Configuration();
$config->setHost('https://demo.docusign.net/restapi'); // 测试环境用demo，生产环境替换为https://www.docusign.net/restapi
$config->addDefaultHeader('Authorization', 'Bearer YOUR_ACCESS_TOKEN'); // 替换成你的实际访问令牌

$apiClient = new ApiClient($config);

// 2. 读取并编码本地DOCX文件
$filePath = 'C:\workspace\myfiles\file.docx';
$fileContent = file_get_contents($filePath);
$base64Content = base64_encode($fileContent);

// 3. 构建文档对象
$document = new Document();
$document->setDocumentBase64($base64Content);
$document->setName('模板核心文档.docx'); // 显示在DocuSign后台的文档名称
$document->setDocumentId('1'); // 模板内文档的唯一标识，多文档场景可递增

// 4. 定义模板收件人角色（可选，按需添加）
$templateRole = new TemplateRole();
$templateRole->setRoleName('合同签署人'); // 角色名称，后续使用模板时可绑定具体收件人
$templateRole->setName('占位姓名'); // 可选：预设角色默认姓名
$templateRole->setEmail('placeholder@example.com'); // 可选：预设角色默认邮箱

// 5. 组装模板对象
$template = new Template();
$template->setName('我的业务合同模板'); // 模板名称
$template->setDocuments([$document]);
$template->setTemplateRoles([$templateRole]); // 如果不需要预设角色，直接删除这行即可

// 6. 调用API创建模板
$templatesApi = new TemplatesApi($apiClient);
$accountId = 'YOUR_ACCOUNT_ID'; // 替换成你的实际账户ID
try {
    $response = $templatesApi->createTemplate($accountId, $template);
    echo "模板创建成功！模板ID：" . $response->getTemplateId();
} catch (Exception $e) {
    echo "创建失败：" . $e->getMessage();
}
?>

4. 关键注意事项 #

• 权限检查：确保你的集成密钥拥有template_create的权限，否则会返回权限不足的错误。
• JWT认证补充：如果用JWT方式，需要替换令牌获取逻辑，比如用$apiClient->requestJWTUserToken()方法生成令牌，具体可以参考SDK内置的JWT示例。
• 文件限制：DocuSign支持DOCX格式直接上传，无需额外转换；注意文件大小不要超过平台限制（一般是25MB以内）。
• 环境切换：测试完成后，把API Host换成生产环境地址即可上线使用。

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