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

Barcode Reader

掃描上傳的影像中所有類型的條碼與 QR code。針對每個偵測到的碼回傳解碼後的文字、條碼類型及位置資料。同時產生一張標註影像,在偵測到的碼周圍加上彩色邊界框。

API Endpoint

POST /api/v1/tools/image/barcode-read

接受包含影像檔案及選用 JSON settings 欄位的 multipart form data。

Parameters

ParameterTypeRequiredDefaultDescription
tryHarderbooleanNotrue針對較難讀取的條碼啟用積極掃描模式(較慢但更徹底)

Example Request

bash
curl -X POST http://localhost:1349/api/v1/tools/image/barcode-read \
  -H "Authorization: Bearer si_your-api-key" \
  -F "[email protected]" \
  -F 'settings={"tryHarder": true}'

Example Response

json
{
  "filename": "receipt.jpg",
  "barcodes": [
    {
      "type": "QRCode",
      "text": "https://example.com/product/123",
      "position": {
        "topLeft": { "x": 100, "y": 50 },
        "topRight": { "x": 250, "y": 50 },
        "bottomLeft": { "x": 100, "y": 200 },
        "bottomRight": { "x": 250, "y": 200 }
      }
    },
    {
      "type": "EAN-13",
      "text": "5901234123457",
      "position": {
        "topLeft": { "x": 50, "y": 400 },
        "topRight": { "x": 300, "y": 400 },
        "bottomLeft": { "x": 50, "y": 450 },
        "bottomRight": { "x": 300, "y": 450 }
      }
    }
  ],
  "annotatedUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/annotated-receipt.png",
  "previewUrl": "/api/v1/download/a1b2c3d4-e5f6-7890-abcd-ef1234567890/annotated-receipt.png"
}

Response Fields

FieldTypeDescription
filenamestring原始檔名
barcodesarray偵測到的條碼物件陣列
annotatedUrlstring or null下載標註影像的 URL(若未找到條碼則為 null)
previewUrlstring or null與 annotatedUrl 相同(供前端預覽相容性使用)

Barcode Object

FieldTypeDescription
typestring條碼格式(QRCode、EAN-13、Code128、DataMatrix、PDF417 等)
textstring條碼解碼後的內容
positionobject含 topLeft、topRight、bottomLeft、bottomRight 座標的邊界框

Supported Barcode Types

1D 條碼:Code128、Code39、Code93、Codabar、EAN-8、EAN-13、ITF、UPC-A、UPC-E

2D 條碼:QRCode、DataMatrix、PDF417、Aztec、MaxiCode

Notes

  • 使用 zxing-wasm 函式庫進行條碼偵測。
  • 標註影像會在每個偵測到的條碼上疊加彩色多邊形邊界框及編號標籤。
  • 單張影像最多可偵測 255 個條碼。
  • 若未找到條碼,barcodes 為空陣列,且 annotatedUrl 為 null。
  • tryHarder 模式會以耗費處理時間為代價執行更徹底的掃描。若條碼乾淨、對齊良好,可停用此模式以加快處理。
  • 標註輸出一律為 PNG 格式。
  • HEIC、RAW、PSD 及 SVG 輸入會在掃描前自動解碼。
  • EXIF 方向會在處理前自動套用。