ForHosting KIT · PDF・文書ツール

PDFフォーム項目の名前・種類・現在値を一覧表示

PDFは単純なページに見えても、表示デザインの背後に構造化されたフォームを保持している場合があります。この機能はその構造を読み取り、すべての項目について完全な名前、認識した種類、現在値を分かりやすく返します。申請書、アンケート、承認書、受付書類で一般的なAcroFormのコントロールに対応しています。処理は決定的かつローカルで行われ、ネットワーク要求、モデルによる推測、ランダムな結果はありません。入力がPDFではない場合、破損している場合、フォーム項目がない場合には、成功と誤認しやすい空の結果ではなく、明確な入力エラーを返します。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

PDFフォーム内部の実際の構造を確認します

対話型PDFフォームでは、各ページに描画された文字や線とは別にコントロールが保存されています。画面上では「郵便番号」とだけ表示されていても、内部名がcustomer.address.postcodeであることがあります。この機能は文書カタログからAcroForm辞書をたどり、項目ツリーを走査し、継承されたプロパティを適用して、末端項目を文書内の順序で返します。各結果には完全な項目名、正規化した種類、PDFに保存されている現在値が含まれます。テキスト欄、チェックボックス、ラジオグループ、ドロップダウン、選択リスト、押しボタン、署名欄は、文書で定義された項目種類とフラグによって区別されます。階層名はピリオドで結合されるため、異なるセクションに似た名前のコントロールがあっても曖昧になりません。そのため、出力は表示テキストの単純な抽出ではなく、機械で扱えるスキーマ一覧として利用できます。選択されていないチェックボックスはfalse、未署名の署名欄は署名が存在するかのように扱わず明示されます。

文書を送信して応答を正しく読み取ります

pdfパラメーターには、PDFを通常のbase64文字列、またはbase64形式のapplication/pdfデータURLとして指定してください。パーサーは最初にエンコードとPDFヘッダーを検証し、次にカタログと項目ツリーの特定に必要な間接オブジェクトを読み取ります。応答にはレコード配列のfieldsと、返された項目数を示すcountが含まれます。種類にはTextField、CheckBox、RadioGroup、Dropdown、OptionList、PushButton、Signatureなどの実用的な名前を使用します。PDF内で文字列や配列として保存された現在値はその形式を維持し、チェックボックスの状態は真偽値で返します。空のテキスト系コントロールには空文字列を使用するため、存在しない項目と区別できます。コントロールのそばに印刷された表示ラベルを項目名とみなさないでください。返される名前は内部定義だけで決まります。項目がない場合は意図的にエラーとなるため、フラット化済みPDF、紙フォームのスキャン、誤った添付ファイルを自動処理で検知できます。安定した処理のため入力サイズには上限があります。

文書処理で項目一覧を安全に活用します

項目一覧は、PDFフォームへの入力、検証、移行、監査を始める前の有効な第一段階です。たとえば受付システムでは、テンプレートに顧客データを書き込む前に、返された名前とデータベースのキーを比較できます。品質管理では、改訂版にも必須項目が残っているか、コントロールの種類が予期せず変わっていないかを確認できます。アーカイブ移行では、長期保存のためにフラット化する前に、各対話型文書へ埋め込まれた値を記録できます。このアルゴリズムは外部サービスを呼び出さず、ページの見た目から値を推測しないため、同じバイト列の要求は同じJSONを返します。この再現性はテストや監査証跡で重要です。ただし、これはAcroForm構造の読み取り機能であり、光学文字認識ではありません。紙フォームのスキャンには画像しかなく対話型項目がないため、項目なしのエラーになります。また、文書の変更、フラット化、署名、復号、修復は行いません。暗号化済みファイルやフォームオブジェクトを読めないPDFは、送信前に適切なPDFツールで準備してください。

活用例

入力前にフォーム構造を把握します

顧客データを送る前に、入力処理が対象とすべき正確な内部名とコントロール種類を確認します。

テンプレートの退行を検出します

PDFフォームの新版が公開された際、返された一覧を承認済み仕様と比較します。

保存済み回答を監査します

対話型の申請書や承認書から現在値を抽出し、構造化された確認や移行に利用します。

よくある質問

1回の要求にかかる料金はいくらですか？

APIの料金は1回の要求につき$0.002です。

どのPDF項目種類を認識できますか？

テキスト欄、チェックボックス、ラジオグループ、メニュー、リスト、ボタン、署名欄を区別します。

PDFにフォームがない場合はどうなりますか？

フォーム項目が存在しないことを示す入力エラーを返します。

紙フォームのスキャンも読み取れますか？

いいえ。スキャンにはOCRが必要で、この機能は対話型AcroForm構造を読み取ります。

文書の変更や入力も行いますか？

いいえ。名前、種類、現在値を報告するだけで、送信されたPDFは変更しません。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/pdf/list-form-fields

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/pdf/list-form-fields \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"pdf":"https://ejemplo.com/documento.pdf"}'

const res = await fetch("https://api.kit.forhosting.com/pdf/list-form-fields", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "pdf": "https://ejemplo.com/documento.pdf"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/pdf/list-form-fields",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "pdf": "https://ejemplo.com/documento.pdf"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/pdf/list-form-fields", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"pdf":"https://ejemplo.com/documento.pdf"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"pdf":"https://ejemplo.com/documento.pdf"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/pdf/list-form-fields", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "pdf": "https://ejemplo.com/documento.pdf"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "pdf.list_form_fields",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

制限

`max_mb`	25
`max_pages`	200

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →