我们的 PDF API 公开了什么 - 信用和限制

API 页面的增长速度往往比 API 更快。我们现在仅列出无需浏览器即可完成的路线：帐户、编辑和比较。那是故意的。无法完成其工作流程的端点比根本没有端点更糟糕。

今天直播什么

• 获取/v1/我 — 账户、计划和实时信用余额；每次通话 1 个积分。
• POST /v1/redact-pdf — 查找图案、文本或图像，并返回经过编辑的 PDF apply=1。自由的。
• POST /v1/比较-pdf — 统计数据、更改的块以及两个 PDF 之间的主要差异。自由的。

这三个人都从“我的帐户”中获取不记名密钥。结果是 JSON，带有下载链接，有效期为两个小时；原件永远不会被修改。

API 中没有的内容

目前 API 的收费标准

仅存在三个路线： GET /v1/me 花费 1 个学分，同时 POST /v1/redact-pdf 和 POST /v1/compare-pdf 每个花费 5 个学分。没有合并或 OCR API 费用，因为这些工具不是 API 端点。实时汇率位于 计划和定价 页。

为什么电子签名器不是一条路线

签名是浏览器工作流程的两倍：发件人在页面上放置字段，收件人打开链接并签名。 HTTP 客户端无法查看布局或操作该页面，因此“电子签名 API”将在作业完成之前停止。信封位于电子签名者仪表板中； API 不会创建或签署它们。

密钥和文件保留

将 API 密钥视为密码：每个应用程序一个密钥，如果已将其粘贴到公共存储库中，则轮换它，并且切勿将其放入浏览器端 JavaScript 中。上传的文件是临时工作副本，具有不可猜测的 id；它们不是文档存储。将原始文件保存在您自己的存储中，并将 API 响应视为派生副本。的 安全页面 列出控件和保留窗口。

升级前要测量什么

每月跟踪三个号码：成功呼叫、失败呼叫以及最后的信用余额。编辑和比较是付费的（各 5 个学分），因此可以在余额中看到忙碌的一个月；帐户调用成本 1。如果重试或高峰月峰值确实消耗积分，则较大的计划比失败的批次便宜。由于未使用的积分会滚动，因此安静的一个月不会被浪费。

电子签名器仅适用于浏览器。 必须有人以可视方式放置收件人的签名字段，并且收件人必须打开签名页面并签名。 HTTP 客户端两者都做不到，因此没有 API 路由来创建、签名、列出或轮询信封。电子签名者仪表板仍然是完成这项工作的正确位置。

相同的测试暂时从 API 中删除了合并、压缩、转换和编辑器：它们有用的工作流程是交互式的且文件量大。它们在浏览器中保持免费状态，而不是被宣传为半工作端点。

信用能买什么

积分是附加到商业帐户的预付余额。目前唯一的付费 API 路线是 GET /v1/me 1 学分，编辑和比较各 5 学分。计划仍然包括每月信用额度，未使用的信用额度会滚动而不是过期。我们在以下位置列出了实时 API 费率： 计划和定价 页面，并且不要发布不存在路线的每个工具的价格。

关键、限制和安全

API 密钥仅显示一次并仅存储为哈希值。已撤销的密钥将立即停止工作。每个密钥和每个 IP 速率限制答案 429 与 Retry-After，上传受到大小和页数的限制，并且被禁止或无授权的帐户无法使用实时密钥。的 API页面 记录三个路由及其请求字段。

开始使用

创建一个帐户，如果您需要 API 密钥，请激活商业计划，然后在“我的帐户”中创建密钥并调用 GET /v1/me 首先。如果浏览器工具可以完成这项工作，请使用浏览器工具 - 它是免费的。