KodaPdf 文档和指南

身份验证和 API 密钥管理

该 API 对所有开发人员端点使用无状态 JWT 身份验证。您必须在每个请求的标头中包含您唯一的 API 密钥。 开发者 API 密钥 从您的个人资料设置生成。

X-Api-Key: Your_Developer_API_Key
Content-Type: application/json

第 1 步：上传要转换的文件

在通过 API 执行操作之前，您必须将文件上传到系统。该端点接受 多部分/表单数据 数据负载。

请求示例（按语言选择）：

curl -X POST "https://kodapdf.com/api/files/upload" \
  -H "X-Api-Key: Your_Developer_API_Key" \
  -F "file=@report.docx"

成功响应 (JSON - 201 Created)：

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "fileName": "report.docx",
  "size": 4194304
}

HTTP 响应代码：

第 2 步：异步任务队列流程

上传文件并获得 文件编号 ，您可以通过向目标转换或 PDF 操作端点发送请求来触发后台任务。完成后，您将获得安全下载链接。

跟踪任务状态（轮询或 Webhooks）

使用返回的 ID 定期查询任务状态 (GET) 职位编号 在以下 URL 端点处：

作业查询示例：

curl -X GET "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b" \
  -H "X-Api-Key: Your_Developer_API_Key"

返回的响应（任务成功完成）：

{
  "id": "e4f8d22c-a2b1-4f33-bd54-72123456789b",
  "status": "Completed",
  "fileName": "report.pdf",
  "downloadUrl": "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b/download"
}

任务生命周期状态：

REST API 端点参考

以下是最常用的异步任务参数和 API 模板。上传文件后，传递返回的 文件编号 在 JSON 请求体中：

curl -X POST "https://kodapdf.com/api/jobs" \
  -H "X-Api-Key: Your_Developer_API_Key" \
  -H "Content-Type: application/json" \
  -d '{
    "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
    "sourceFormat": "docx",
    "targetFormat": "pdf",
    "originalFileName": "report.docx"
  }'

{
  "fileIds": [
    "8a7c93e4-b78f-4ad5-9c60-06123456789a",
    "9b8d04f5-c89g-5be6-0d71-1723456789ab"
  ],
  "outputFileName": "merged_document.pdf"
}

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "text": "CONFIDENTIAL",
  "opacity": 0.25,
  "outputFileName": "watermarked.pdf"
}

{
  "fileId": "8a7c93e4-b78f-4ad5-9c60-06123456789a",
  "patterns": ["SECRET", "05\\d{9}"],
  "outputFileName": "redacted.pdf"
}

Webhook 通知（回调 API）

我们的系统支持自动 Webhook 订阅，在作业完成时直接 ping 您的 Web 服务，从而避免通过 GET 查询进行手动轮询。 邮政 /api/Webhook/订阅

订阅请求正文：

{
  "target_url": "https://api.yoursite.com/kodapdf-callback",
  "event_type": "job.completed"
}

完成时发送到您的服务器的 JSON（有效载荷）：

{
  "id": "e4f8d22c-a2b1-4f33-bd54-72123456789b",
  "fileName": "report.pdf",
  "status": "Completed",
  "sourceFormat": "docx",
  "targetFormat": "pdf",
  "downloadUrl": "https://kodapdf.com/api/jobs/e4f8d22c-a2b1-4f33-bd54-72123456789b/download",
  "event_type": "job.completed"
}