README

介绍

ComPDFKit 提供强大且稳定的 PDF 库和完整 PDF 功能，以构建 PDF 查看器和编辑器，允许预览、编辑、注释、签名、加密和解密 PDF 文件。

ComPDFKit API 提供了多种 PHP API 工具，允许您通过单个 API 调用创建高效的文档处理工作流程。

ComPDFKit API 允许您每月处理 1000 个文件！只需注册免费试用，即可享受全面的 PDF 功能。

要求

编程环境：PHP 版本 7.0 及以上。

依赖：Composer。

安装

您可以通过 Composer 安装库。运行以下命令。

composer require compdfkit/compdfkit-api-php

或者，您可以将 "compdfkit/compdfkit-api-php": "^1.2.4" 添加到您的 "composer.json" 文件中，然后运行它。

composer update

如果您没有使用具有自动加载功能的 PHP 框架，您需要使用以下代码来自动加载。

require_once('vendor/autoload.php');

用法

创建 API 客户端

首先，请创建一个 API 客户端以完成身份验证。您需要登录您的 ComPDFKit API 账户，在仪表板获取您的 publicKey 和 secretKey。如果您是 ComPDFKit 的新用户，请点击此处注册免费试用，每月免费处理 1,000 份文档。

项目公钥：您可以在 ComPDFKit API 账户的 API Keys 部分找到公钥。
项目密钥：您可以在 ComPDFKit API 账户的 API Keys 部分找到密钥。

$client = new CPDFClient('public_key', 'secret_key');

创建任务

根据您选择的 PDF 工具类型，系统将自动为您生成一个任务 ID。您可以为任务提供回调通知 URL。任务处理完成后，我们将通过回调接口通知您任务结果。您可以根据请求结果执行其他操作，例如检查任务状态、上传文件、启动任务或下载结果文件。

// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);

上传文件

上传原始文件并将文件绑定到任务 ID。字段参数用于传递 JSON 字符串以设置文件的处理参数。每个文件将自动生成一个唯一的文件密钥。请注意，每个任务 ID 最多可以上传五个文件，且任务开始后不能上传文件。

// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);

// Upload files
$file = $client->addFile('test.pdf')->uploadFile($taskInfo['taskId']);

执行任务

文件上传完成后，使用任务ID调用此接口处理文件。

// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);

// Upload files
$file = $client->addFile('test.pdf')->uploadFile($taskInfo['taskId']);

// execute Task
$client->executeTask($taskInfo['taskId']);

获取任务信息

根据任务ID请求任务状态和与文件相关的元数据。

// Create a client
$client = new CPDFClient('public_key', 'secret_key');

// Create a task
// Create an example of a PDF TO WORD task
$taskInfo = $client->createTask(CPDFConversion::PDF_TO_WORD);

// Upload files
$file = $client->addFile('test.pdf')->uploadFile($taskInfo['taskId']);

// Execute Task
$client->executeTask($taskInfo['taskId']);

// Query TaskInfo
$taskInfo = $client->getTaskInfo($taskInfo['taskId']);

示例

在samples文件夹中有许多示例，展示了ComPDFKit API的主要功能和如何使用它们，例如为PDF加水印、将PDF转换为Word、Excel、JPG、PNG等。您可以将代码复制到您的项目中并直接运行。要了解更多关于ComPDFKit API的信息，请访问我们的API参考。

免费试用

ComPDFKit API是一个强大的API，可以用于在单个API调用中创建高效的文档处理工作流程。

如果您没有ComPDFKit API账户，您可以免费试用，每月免费处理1,000份文档。

一旦您拥有ComPDFKit API账户，您可以在仪表板中获取您的publicKey和secretKey。

支持

ComPDFKit拥有一支专业的研发团队，提供全面的技术文档和指南，以帮助开发者。此外，您在向我们的支持团队报告问题时，将立即获得响应。

有关详细信息，请访问我们的指南页面。

通过我们的变更日志了解最新的改进。

如需技术支持，请联系我们的技术支持。

要获取更多详情和准确的报价，请联系我们的销售团队。

许可证

代码在Apache-2.0许可证的条款下作为开源代码提供。

compdfkit / compdfkit-api-php

维护者

详细信息