This page was machine-translated. Spotted a mistake?Help improve it.
Skip to content

簽署 PDF

將一個或多個上傳的簽名 PNG 影像蓋印到 PDF 的任何頁面上。此路由使用自訂的 multipart 合約,因為它需要 PDF、一個或多個簽名影像以及放置座標。

API 端點

POST /api/v1/tools/pdf/sign-pdf

接受 multipart 表單資料。PDF 以 file 傳送;簽名以 sig0sig1 等方式傳送;放置位置則以 placements JSON 欄位傳送。

參數

參數類型必填預設值說明
filefile-要簽署的 PDF 檔案
sig0file-第一張簽名影像。額外的影像使用 sig1sig2
placementsJSON string-放置物件的陣列:{ "sig": 0, "page": 0, "x": 0.2, "y": 0.7, "w": 0.25, "h": 0.08 }
clientJobIdstring-用於透過 SSE 追蹤進度的選填 UUID
fileIdstring-選填的檔案庫 ID,用於將簽署結果儲存為新版本

放置座標

欄位類型說明
siginteger簽名影像索引。0 對應到 sig0
pageinteger以零為起始的 PDF 頁面索引
xnumber以頁面比例表示的左側位置
ynumber以頁面比例表示的頂端位置
wnumber以頁面比例表示的簽名寬度
hnumber以頁面比例表示的簽名高度

座標使用左上角為原點。數值可能略微超出頁面邊緣;PDF 渲染器會將最終的蓋印裁切至頁面範圍。

範例請求

bash
curl -X POST http://localhost:1349/api/v1/tools/pdf/sign-pdf \
  -H "Authorization: Bearer si_your-api-key" \
  -F "[email protected]" \
  -F "[email protected]" \
  -F 'placements=[{"sig":0,"page":0,"x":0.64,"y":0.82,"w":0.22,"h":0.08}]'

範例回應

json
{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "downloadUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/contract_signed.pdf",
  "previewUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/preview.png",
  "originalSize": 245000,
  "processedSize": 249000
}

若請求無法在同步等待視窗內完成,API 會回傳:

json
{
  "jobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "async": true
}

連線到 /api/v1/jobs/<jobId>/progress,並在工作完成時下載結果。

注意事項

  • 接受的 PDF 輸入格式:.pdf
  • 簽名影像必須是有效的影像檔,通常是具有透明度的 PNG。
  • 最多接受 100 張簽名影像與 100 個放置位置。
  • sign-pdf 是一個自訂路由,不使用標準工具的 settings JSON 欄位。