1 Star 0 Fork 0

ComPDF/ComPDFKit API

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
该仓库未声明开源许可证文件(LICENSE),使用请关注具体项目描述及其代码上游依赖。
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README

ComPDFKit API in Java

介绍

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

ComPDFKit API提供了多种 Java API 工具,允许您在单个 API 调用中创建高效的文档处理工作流程。

ComPDFKit API 让您现在每月可以处理 1000 个文件!只需注册免费试用即可享受全面的 PDF 功能。

相关链接

要求

  • 编程环境:Java JDK 1.8 及更高版本。

  • 依赖项:Maven。

安装

您可以直接使用 Maven 存储库安装ComPDFKit API 库的 Maven 存储库。或者,您可以在***“pom.xml”***文件中添加以下依赖项:

<dependency>
    <groupId>com.compdf</groupId>
    <artifactId>compdfkit-api-java</artifactId>
    <version>1.4.1</version>
</dependency>

用法

创建API客户账号

首先,请创建一个 API 客户身份来完成身份验证。您需要登录您的 ComPDFKit API 帐户,以便在账户后台获取您的publicKeysecretKey。如果您是 ComPDFKit 的新用户,请单击此处注册免费试用,每月免费处理 1,000 份文档。

  • 项目公钥:您可以在ComPDFKit API 帐户的API 密钥部分找到公钥。
  • 项目密钥:您可以在ComPDFKit API 帐户的API 密钥部分找到密钥。
CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);

创建任务

根据您选择的PDF工具类型,自动为您生成任务ID,您可以提供回调通知URL,任务处理完成后,我们会通过回调接口通知您任务结果,您可以根据请求结果进行其他操作,如查看任务状态、上传文件、启动任务、下载结果文件等。

// Create a client
CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);

// Create a task
// Create an example of a PDF TO WORD task
CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());

// Get a task id
String taskId = result.getTaskId();

上传文件

上传原始文件,并将文件与任务ID绑定。field参数用于传递JSON字符串,设置文件的处理参数。每个文件会自动生成一个唯一的filekey。请注意,一个任务ID最多可以上传5个文件,任务启动后将无法再上传任何文件。

// Create a client
CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);

// Create a task
// Create an example of a PDF TO WORD task
CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());

// Get a task id
String taskId = result.getTaskId();

// Upload files
client.uploadFile(<convertFile>, taskId);

执行任务

文件上传完成后,通过任务ID调用此接口对文件进行处理。

// Create a client
CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);

// Create a task
// Create an example of a PDF TO WORD task
CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());

// Get a task id
String taskId = result.getTaskId();

// Upload files
client.uploadFile(<convertFile>, taskId);

// execute Task
client.executeTask(taskId, CPDFLanguageConstant.English);

获取任务信息

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

// Create a client
CPDFClient client = new CPDFClient(<publicKey>, <secretKey>);

// Create a task
// Create an example of a PDF TO WORD task
CPDFCreateTaskResult result = client.createTask(CPDFConversionEnum.PDF_TO_WORD.getValue());

// Get a task id
String taskId = result.getTaskId();

// Upload files
client.uploadFile(<convertFile>, taskId);

// Execute Task
client.executeTask(taskId, CPDFLanguageConstant.English);

// Query TaskInfo
CPDFTaskInfoResult taskInfo = client.getTaskInfo(taskId);

示例

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

免费试用

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

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

一旦您拥有 ComPDFKit API 帐户,您就可以在仪表板中获取您的publicKeysecretKey

支持

ComPDFKit拥有专业的研发团队,全面的技术文档和指南来帮助开发人员。此外,当您有其他问题时,我们的团队会在第一时间回复并解决。

许可证

根据Apache-2.0许可条款,该代码可作为开源使用。

空文件

简介

ComPDFKit API 简化您的工作流程。您可以快速轻松地集成 PDF 编辑、PDF 转换、水印、OCR 等功能。 展开 收起
取消

发行版

暂无发行版

贡献者

全部

近期动态

不能加载更多了
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/ComPDFKit/compdfkit-api.git
git@gitee.com:ComPDFKit/compdfkit-api.git
ComPDFKit
compdfkit-api
ComPDFKit API
master

搜索帮助