KodaPdf ドキュメントとガイド

認証と API キーの管理

KodaPdf 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 が作成されました):

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

HTTP 応答コード:

ステップ 2: 非同期ジョブ キュー フロー

ファイルをアップロードして受信した後、 ファイルID の場合は、ターゲットの変換または PDF 操作エンドポイントにリクエストを行うことで、バックグラウンド ジョブをトリガーします。完了すると、安全なダウンロード リンクを取得します。

ジョブ ステータスの追跡 (ポーリングまたは Webhook)

返されたメソッドを使用して、ジョブのステータスを定期的にクエリ (GET) します。 ジョブID 次の 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 テンプレートです。ファイルをアップロードしたら、返されたファイルを渡します ファイルID 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)

当社のシステムは、ジョブの完了時に Web サービスに直接 ping を送信する自動 Webhook サブスクリプションをサポートし、GET クエリによる手動ポーリングを回避します。 役職 /api/Webhook/subscribe

アボネリク・イシュテク・ギョブデシ:

{
  "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"
}