如何获取 ilovepdf开放平台API Key 密钥（分步指南）

在文档处理和文件转换领域，ilovepdf开放平台 API 是一款功能强大的工具，它支持多种文件操作，如PDF压缩、转换等，为开发者提供便捷的集成方案。通过ilovepdf API，用户可以快速处理海量文件任务，提高业务效率。本文将指导你如何获取ilovepdf开放平台API密钥，并进行初步的可用性测试，同时探讨在使用过程中需要考虑的其他关键因素。

1. 获取ilovepdf开放平台 API秘钥步骤

获取ilovepdf开放平台 API密钥的过程相对简单，只需几个步骤即可完成：

1.访问官方网站注册/登录：https://www.iloveapi.com/login

2.新注册的用户需要到填写的邮箱验证才能正常登陆账户

3.登陆成功以后会进入“控制台页面”(新用户注册赠送2500积分)

4.从左侧导航栏中进入API密钥页面查看自己的密钥

5.获取token

方式一：自签名令牌

您需要使用您的私钥和公钥对生成签名令牌，并将其发送到每个请求的 Authorization: Bearer {signed_token} 标头中。

方式二：从官方的认证服务器请求签名令牌
当您向 /auth 资源发送请求时，您将收到一个令牌，用于每个请求（如 /start、/upload、/process、/download）中的 Authorization: Bearer {signed_token} 标头中。我们强烈建议您在需要从 /auth 服务器请求令牌时，启用域名和 IP 过滤功能。这样，只有来自您设定域名的请求才会被接受。请记住，令牌具有过期时间，必须在到期后重新请求。

2. ilovepdf开放平台 API密钥可用性测试

在获取API密钥后，进行可用性测试是确保其正常工作的重要步骤。以下是使用node.js进行测试的一个案例

安装

npm install @ilovepdf/ilovepdf-nodejs

开始任务

要启动任务，您需要直接使用 API 实例创建它：

const ilovepdf = new ILovePDFApi('PUBLIC_KEY');
const myTaskCompress = ilovepdf.newTask('compress');

上传文件

下一步是通过将这些文件添加到任务中来分配您（或您的用户）想要上传的所有文件，如以下代码示例所示：

myTaskCompress.addFile('path/to/file1_name.pdf');
myTaskCompress.addFile('path/to/file2_name.pdf');
myTaskCompress.addFile('path/to/file3_name.pdf');

处理文件

myTaskCompress.process();

下载

最后下载任务结果，只需几行代码，您就可以压缩三个 PDF 文件！

myTaskCompress.download();

完整代码示例

// Authenticate
const ilovepdf = new ILovePDFApi('project_public_id', 'project_secret_key');

// Choose your processing tool and create a new task
myTaskCompress = ilovepdf.newTask('compress');

// For this example, await notation will be used instead of
// promises.

// Add files to task for upload
await myTaskCompress.addFile('path/to/file1_name.pdf');
await myTaskCompress.addFile('path/to/file2_name.pdf');
await myTaskCompress.addFile('path/to/file3_name.pdf');

// Execute the task
await myTaskCompress.process();

// Download the packaged files
const data = await myTaskCompress.download();

3. 使用ilovepdf开放平台 API搭建应用的其他关键考虑因素

在使用ilovepdf开放平台 API搭建应用时，除了获取和测试API密钥外，还需考虑以下因素：

认证方式

我们采用了一种简单但有效的认证方法：JWT（JSON Web Tokens）。每个请求需要在 Authorization 标头中携带通过您的 iLovePDF API 开发者账户提供的 Secret Key 签名生成的令牌（Bearer Token）。

重要事项
- Secret Key 绝不能暴露，但签名的令牌可以暴露，并需要在每个请求的 Authorization: Bearer {signed_token} 参数中发送。
- 所有签名的令牌有效期为 2小时，过期后需重新生成。
- iLovePDF 的所有 API 库会自动管理认证过程，您只需在 API 库中设置您的 Private Key 和 Public Key。

获取签名令牌的两种方法

1. 自签名令牌（推荐用于服务端代码）

您可以使用您的密钥对（Secret Key 和 Public Key）生成签名令牌，并将其添加到每个请求的 Authorization: Bearer {signed_token} 标头中。

可以直接在 JWT 官方网站找到相关的 JWT 库。
注意事项
- exp（过期时间）、nbf（不可用时间）和 iat（签发时间）等声明必须使用 UTC 时区。

2. 通过认证服务器请求签名令牌（推荐用于客户端代码）

向 /auth 资源发送请求时，您将收到一个用于每个请求（如 /start、/upload、/process、/download）的签名令牌。

建议：启用域名和 IP 过滤功能，以确保只有来自您指定域名的请求才能被认证服务器接受。
注意事项
- 令牌具有过期时间，过期后需要重新请求。

速率限制

所有端点均受到 API 速率限制，具体取决于层。作为每个响应的一部分，HTTP 标头将显示您当前的速率限制状态。

常见 HTTP 错误代码

HTTP 错误代码	描述
200 – OK	请求成功，工作正常。
400 – Bad Request	请求不可接受，通常是因为缺少必要参数。
401 – Unauthorized	未提供有效的 API 密钥或密钥不正确。
404 – Not Found	请求的资源不存在。
429 – Too Many Requests	请求过于频繁，请求超出速率限制。建议对请求进行指数回退。
5xx – Server Errors	API 服务器内部出现问题。

400 错误类型

错误类型	描述
UploadError	请求中缺少某些参数或文件，或者某些操作出错。
ProcessingError	请求中缺少某些参数或处理失败。
DownloadError	文件可能已被移除或过期。

4. ilovepdf开放平台 API密钥申请和使用中的常见问题

在申请和使用 ilovepdf开放平台 API密钥过程中，你可能会遇到以下常见问题：

1.订阅套餐和预付费套餐有什么区别？

预付费套餐是一次性付款，可为您提供文件处理积分。文件积分不会过期，因此您可以随时处理购买的文件数量。这为您的文件处理提供了最大的灵活性。

订阅计划每月为您提供固定数量的文件处理积分。请注意，未使用的文件处理积分将在月底到期。您可以选择按月或按年订阅，享受 20% 的折扣。

2.有免费试用吗？

是的。为了了解 iLoveAPI 是否适合您，我们让您免费处理前 2500 个每月积分。对于数字签名，不提供免费积分。

3.当文件无法处理时会发生什么？ 只有成功处理的文件才会被计数并从您的信用中扣除。如果您订阅了月度计划并且还购买了预付费套餐，则文件将始终首先从您的月度计划积分中扣除。在同一任务中合并多个 PDF 文件时，这将被计为正在处理的一个文件。

4.当我达到文件处理限制时会发生什么？ 一旦您使用了 85% 的文件额度，我们将通过电子邮件通知您，以便您及时升级订阅或购买预付费套餐。

5. ilovepdf开放平台 API进阶指引

在获得ilovepdf开放平台 API密钥之后，即可开启API接口对接，本文整理了多篇使用ilovepdf开放平台 API的案例，帮助读者更有效地使用ilovepdf开放平台 API：

拆分 PDF、压缩 PDF、将 Office 转换为 PDF、 HTML 转 PDF、将图像转换为 PDF

6. 常见问题

问题1：什么是幂简集成平台？

幂简集成是蜜堂有信在2023年打造的一款SAAS产品，建设着国内最全的API平台，为开发者提供全面、高效、易用的API集成管理方案，一站搜索、试用、集成国内和国外API。让用户在AI时代全方位接入互联网，用API连接一切服务和算力，实现价值倍增。

问题2：如何找到ilovepdf开放平台 API

幂简API平台可以通过以下两种方式找到所需API：通过关键词搜索API(例如，输入’ilovepdf开放平台 API‘这类品类词，更容易找到结果)、或者从API hub分类页进入寻找。

问题3：ilovepdf开放平台 API的替代品有哪些？

市场上存在免费、付费两种替代者

例如

合并 PDF-api2pdf

HTML转PDF -api2pdf

PDF生成器-PDF Generator API

PDF.ai

合并PDF-PDFBlocks

更多竞品可以在ilovepdf开放平台找到。

7. 总结

在本文中，我们详细介绍了如何使用ilovepdf开放平台API，包括API密钥的获取和可用性测试、如何进行文件上传、处理和下载操作。此外，还探讨了在构建应用时需要注意的认证方式、速率限制以及常见的HTTP错误代码。同时，我们回答了一些与API申请和使用相关的常见问题，并提供了关于文件处理额度和免费试用的信息。最后，我们还分享了更多的API使用案例，帮助开发者更好地利用ilovepdf开放平台API实现各种PDF处理功能。