API スキャン

API スキャンは、Look Scannedが提供するリモート処理機能です。PDFをアップロードしてスキャンジョブを作成し、シンプルなAPIコールで状態を確認してリアルなスキャン風PDFを取得できるため、自動化や開発への組み込みに適しています。色、ノイズ、ぼかし、枠線、回転角度などをカスタマイズでき、さまざまな開発環境や主要なプログラミング言語から、Look Scannedのコア機能をアプリケーションやサービスへ簡単に統合できます。

API Bearer Token

コード例

TypeScriptPythoncURL

interface ScanConfig {
  rotate?: number                // degrees to rotate the document
  rotate_var?: number            // degrees to rotate the document randomly
  colorspace?: 'gray' | 'sRGB'   // the colorspace of the output image
  blur?: number                  // the amount of blur to apply to the image
  noise?: number                 // the amount of noise to apply to the image
  border?: boolean               // whether to add a border to the image
  brightness?: number            // the brightness of the image. 1 is no change
  contrast?: number              // the contrast of the image. 1 is no change
  resolution?: number            // the resolution of the image in DPI
  output_format?: 'image/png' | 'image/jpeg' // the format of the output image
}

interface ScanOptions {
  config: ScanConfig
  webhookUrl?: string        // webhook URL to notify when job is completed
}

interface ScanResponse {
  jobID: string              // UUID of the scan job
  userID: string             // UUID of the user who created the job
  createdAt: number          // timestamp of job creation
  status: 'pending' | 'processing' | 'completed' | 'failed'
  config: ScanConfig
  inputUploadedAt?: number   // timestamp when input file was uploaded
  completedAt?: number       // timestamp when job was completed
  webhookUrl?: string        // webhook URL for notifications
  uploadURL?: string         // S3 presigned URL for file upload
  downloadURL?: string       // S3 presigned URL for file download
}

async function apiScan(pdfBlob: Blob, scanOptions: ScanOptions, token: string): Promise<ScanResponse> {
  const response = await fetch('https://api.lookscanned.io/v1/scan-jobs', {
    method: 'POST',
    headers: {
      'Authorization': `Bearer ${token}`
    },
    body: JSON.stringify(scanOptions)
  })
  const result: ScanResponse = await response.json()

  // PUT PDF Blob to upload URL
  const uploadURL = result.uploadURL
  await fetch(uploadURL, {
    method: 'PUT',
    headers: {
      'Content-Type': 'application/pdf',
      'Content-Length': pdfBlob.size.toString()
    },
    body: pdfBlob
  })
  
  // get scan job status
  const jobStatusResponse = await fetch(`https://api.lookscanned.io/v1/scan-jobs/${result.jobID}`, {
    headers: {
      'Authorization': `Bearer ${token}`
    }
  })
  return await jobStatusResponse.json()
}

import requests

def api_scan(pdf_file, scan_options, token):
    # Create scan job
    response = requests.post(
        'https://api.lookscanned.io/v1/scan-jobs',
        headers={'Authorization': f'Bearer {token}'},
        json=scan_options
    )
    result = response.json()

    # Upload PDF to presigned URL
    upload_url = result['uploadURL']
    requests.put(
        upload_url,
        headers={
            'Content-Type': 'application/pdf',
            'Content-Length': str(len(pdf_file))
        },
        data=pdf_file
    )
    
    # Get scan job status
    job_status = requests.get(
        f'https://api.lookscanned.io/v1/scan-jobs/{result["jobID"]}',
        headers={'Authorization': f'Bearer {token}'}
    )
    return job_status.json()

# Example usage
if __name__ == "__main__":
    with open('document.pdf', 'rb') as f:
        pdf_content = f.read()
    
    options = {
        'config': {
            # Optional parameters:
            # 'rotate': 0,              # degrees to rotate the document
            # 'colorspace': 'gray',     # gray or sRGB
            # 'resolution': 300,        # DPI
            # 'rotate_var': 0,          # random rotation variance in degrees
            # 'blur': 0,                # amount of blur
            # 'noise': 0,               # amount of noise
            # 'border': False,          # whether to add border
            # 'brightness': 1,          # 1 is no change
            # 'contrast': 1,            # 1 is no change
            # 'output_format': 'image/png'  # image/png or image/jpeg
        },
        'webhookUrl': 'https://example.com/webhook'
    }
    
    result = api_scan(pdf_content, options, 'your-api-token')
    print(f"Scan job created with ID: {result['jobID']}")

# Set your API token and PDF file as environment variables
export LOOKSCANNED_API_TOKEN='your_api_token_here'

# Create a new scan job
curl -X POST 'https://api.lookscanned.io/v1/scan-jobs' \
  -H "Authorization: Bearer ${LOOKSCANNED_API_TOKEN}" \
  -H 'Content-Type: application/json' \
  -d '{
    "config": {
      "rotate": 0,
      "rotate_var": 1,
      "colorspace": "gray",
      "blur": 0.2,
      "noise": 0.1,
      "border": true,
      "brightness": 1.0,
      "contrast": 1.0,
      "resolution": 300,
      "output_format": "image/jpeg"
    },
    "webhookUrl": "https://your-domain.com/webhook"
  }'

# Response will include uploadURL and jobID
# {
#   "jobID": "550e8400-e29b-41d4-a716-446655440000",
#   "userID": "446655440000-e29b-41d4-a716-550e8400",
#   "createdAt": 1616161616,
#   "status": "created",
#   "uploadURL": "...",
#   "config": { ... }
# }

# Upload PDF file to the presigned URL
curl -X PUT 'PRESIGNED_UPLOAD_URL' \
  -H 'Content-Type: application/pdf' \
  -H "Content-Length: PDF_FILE_SIZE" \
  --data-binary "@path/to/your/file.pdf"

# Check job status
curl 'https://api.lookscanned.io/v1/scan-jobs/JOB_ID' \
  -H "Authorization: Bearer ${LOOKSCANNED_API_TOKEN}"

# Response will include status and downloadURL when completed
# {
#   "jobID": "550e8400-e29b-41d4-a716-446655440000",
#   "status": "completed",
#   "downloadURL": "...",
#   ...
# }

# Download the PDF
curl -o scanned.pdf 'DOWNLOAD_URL'

試してみる

色空間

解像度 (DPI)

回転

回転のばらつき

ぼかし

ノイズ

明るさ

コントラスト

枠線

出力形式

{
  "config": {
    "rotate": 1,
    "rotate_var": 0.5,
    "colorspace": "gray",
    "blur": 0,
    "noise": 0,
    "border": false,
    "brightness": 1.3,
    "contrast": 1.3,
    "resolution": 150,
    "output_format": "image/jpeg"
  }
}