PDF Tools API

PDF墨消し API

バックエンド、バッチ処理、プロダクト内のワークフローにPDFを墨消しを組み込み、PDF処理基盤の自前運用を減らします。

Create API Key Read full API docs

Credits

1 Credit / call

1 Credit per successful API request. Failed processing attempts are refunded automatically.

Pricing

1,000 Credits = $1

Every signed-in user receives 100 free API Credits each month.

Endpoint

/api/external/pdf-tools/pdf-redaction

Use your API Key in the x-api-key header.

Use case

個人番号、金額、顧客情報、社内メモを共有前に隠す場面で使います。手作業の確認はWebツール、安定したサーバー側処理はAPIに分ける設計です。

cURL example

curl -X POST https://itextmaster.com/api/external/pdf-tools/pdf-redaction \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@input.pdf;type=application/pdf' \
  -F 'options={"areas":[{"page":1,"x":72,"y":120,"width":180,"height":36,"replacementText":"REDACTED"}],"color":{"r":0,"g":0,"b":0}}' \
  --output redacted.pdf

Multipart example

curl -X POST https://itextmaster.com/api/external/pdf-tools/pdf-redaction \
  -H 'x-api-key: YOUR_API_KEY' \
  -F 'file=@input.pdf;type=application/pdf' \
  -F 'options={"areas":[{"page":1,"x":72,"y":120,"width":180,"height":36,"replacementText":"REDACTED"}],"color":{"r":0,"g":0,"b":0}}' \
  --output redacted.pdf

JSON base64 example

curl -X POST https://itextmaster.com/api/external/pdf-tools/pdf-redaction \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY' \
  -d '{
    "file": { "name": "input.pdf", "dataBase64": "JVBERi0xLjcK..." },
    "options": {"areas":[{"page":1,"x":72,"y":120,"width":180,"height":36,"replacementText":"REDACTED"}],"color":{"r":0,"g":0,"b":0}}
  }' \
  --output redacted.pdf

Node.js example

import { writeFile } from 'node:fs/promises';

const response = await fetch('https://itextmaster.com/api/external/pdf-tools/pdf-redaction', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': process.env.ITEXTMASTER_API_KEY
  },
  body: JSON.stringify({
  file: { name: 'input.pdf', dataBase64: 'JVBERi0xLjcK...' },
  options: {"areas":[{"page":1,"x":72,"y":120,"width":180,"height":36,"replacementText":"REDACTED"}],"color":{"r":0,"g":0,"b":0}}
})
});

if (!response.ok) {
  throw new Error(await response.text());
}

await writeFile('redacted.pdf', Buffer.from(await response.arrayBuffer()));

Python example

import os
import requests

response = requests.post(
    'https://itextmaster.com/api/external/pdf-tools/pdf-redaction',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': os.environ['ITEXTMASTER_API_KEY'],
    },
    json={
        'file': {'name': 'input.pdf', 'dataBase64': 'JVBERi0xLjcK...'},
        'options': {'areas': [{'page': 1, 'x': 72, 'y': 120, 'width': 180, 'height': 36, 'replacementText': 'REDACTED'}], 'color': {'r': 0, 'g': 0, 'b': 0}}
    },
)
response.raise_for_status()

with open('redacted.pdf', 'wb') as f:
    f.write(response.content)

Error codes

401invalid_api_key

x-api-keyがない、無効、またはローテーション済みです。

402insufficient_credits

アカウントのAPI Creditsが不足しています。

422pdf_tool_processing_failed

ファイル、オプション、PDF構造を処理できませんでした。失敗分のCreditsは自動で戻ります。

Limits

正常に開けるPDFまたは有効な入力データが必要です。
API Keyはサーバー側に置き、ブラウザには公開しないでください。
大量処理の前に代表的なファイルで出力を確認してください。

Response headers

redacted.pdf とともに、使用Creditsと残高を示すレスポンスヘッダーが返ります。

Content-Type: 生成ファイルのMIMEタイプです。通常はapplication/pdfまたはapplication/zipです。
Content-Disposition: 生成ファイルのダウンロード名です。
X-Credits-Charged: 成功したリクエストで消費されたCreditsです。
X-Credit-Balance: リクエスト後のAPI Credits残高です。

FAQ