メインコンテンツへスキップ
PDF4me API統合AIとSDK知識ベース拡張機能APIテスターブログ

フォームデータを抽出する PDF - フィールドパーサー API

PDF4me フォームデータを抽出する PDF フォームフィールドのすべてのデータと値を抽出できます PDF 入力可能なフォームを含む文書。 API サービスプロセス PDF ファイルと抽出フォームのフィールド情報、値、プロパティ PDF 形式。 API 受け取る PDF コンテンツを通じて REST API 通話を利用して Base64 安全なデータ送信のためのエンコード機能を搭載。様々なフォームフィールドタイプと構造化データ出力に対応しており、フォーム処理ワークフローやデータ抽出プラットフォームに最適なソリューションです。

関連ブログ記事
この機能に関するブログ記事はまだありません。近日公開予定です。
その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。
ブログをご覧ください →

認証 API リクエスト​

アクセスするには PDF4me REST APIすべてのリクエストには適切な認証情報を含める必要があります。認証により安全な通信が保証され、あなたが正規のユーザーであることが検証されます。 REST API。

Get your api Key

主な機能​

  • フォームフィールドの抽出テキストフィールド、チェックボックス、ラジオボタン、ドロップダウンリスト、署名フィールドなど、あらゆる種類のフォームフィールドを抽出します。
  • 構造化データ出力: フォームデータを構造化して取得する JSON 簡単に統合できるフォーマット
  • フィールドプロパティフィールド名、値、型、および検証プロパティを抽出します。
  • Base64 エンコーディング: 安全なファイルコンテンツ送信 Base64 エンコーディング
  • 単純 API 統合: 安らかな API 自動フォーム処理ワークフロー向けに設計されています

REST API 終点​

の PDF4me REST API 標準を使用する HTTP リソースとやり取りするためのメソッド。すべてのフォームデータ抽出操作は、単一のエンドポイントを介して実行されます。

  • 方法： POST
  • 終点： /api/v2/ExtractPdfFormData

REST API パラメータ​

「フォームデータ抽出」のパラメータ一覧 PDF REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

重要： アスタリスク (*) が付いているパラメータは必須であり、提供する必要があります。 API 正しく機能するため。

パラメータ必須その機能例
jobIdExtOptionalYour own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string.
integrationsOptionalIntegration identifiers, forwarded unchanged with the job's notification settings. Type: array.
isAsyncOptionalSet to `true` to process the action asynchronously and get a job to poll at `/api/v2/GetActionStatus`. Only honoured by actions that support asynchronous processing. Type: boolean.true
docNameOptionalSource file name including its extension. Several actions dispatch on the extension, so it should always be set; when omitted a per-action default is used. Type: string.output.pdf
docContentRequiredThe source file. Accepts the base64-encoded file content, a `pdf4meblobid://<id>` reference to a previously uploaded blob, or an `https` URL to the source document. Required: an empty value fails with `File is empty`. Type: string.JVBERi...
docContentBytesOptionalAlternative raw byte payload for the source file. Type: string.
callBackUrlOptionalOptional URL notified when an asynchronous job completes. Type: string.

出力​

の PDF4me フォームデータを抽出する PDF REST API 処理モードに基づいて異なる応答を返します。 API 抽出されたフォームフィールドデータを JSON 応答。

同期処理（デフォルト）

いつ async は false または提供されていない場合、 API 抽出されたフォームデータを即座に返します。

ステータスコード: 200 OK

回答形式：

{
  "formFields": [
    {
      "fieldName": "Name",
      "fieldValue": "John Doe",
      "fieldType": "text"
    },
    {
      "fieldName": "Email",
      "fieldValue": "[email protected]",
      "fieldType": "text"
    },
    {
      "fieldName": "Date",
      "fieldValue": "2024-01-15",
      "fieldType": "date"
    }
  ]
}

レスポンスには、フォームフィールドの名前、値、および型を含む配列が含まれています。

リクエスト例​

ヘッダ​

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

注記：

  • 手に入れよう API 鍵から PDF4me ダッシュボード
  • の API キーは Base64 エンコードされ、「Basic」がプレフィックスとして付加されています。 Authorization ヘッダー
  • 例: API 重要なのは abc123エンコードして Base64 そして使用する Authorization: Basic YWJjMTIz

ペイロード​

基本的なリクエスト:

{
  "docContent": "JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFszIDAgUl0KL0NvdW50IDEKPD4KZW5kb2JqCjMgMCBvYmoKPDwKL1R5cGUgL1BhZ2UKL1BhcmVudCAyIDAgUgovTWVkaWFCb3ggWzAgMCA2MTIgNzkyXQovUmVzb3VyY2VzIDw8Ci9Gb250IDw8Ci9GMSA0IDAgUgo+Pgo+PgovQ29udGVudHMgNSAwIFIKPj4KZW5kb2JqCjQgMCBvYmoKPDwKL1R5cGUgL0ZvbnQKL1N1YnR5cGUgL1R5cGUxCi9CYXNlRm9udCAvSGVsdmV0aWNhCj4+CmVuZG9iago1IDAgb2JqCjw8Ci9MZW5ndGggNDQKPj4Kc3RyZWFtCkJUCi9GMSAxMiBUZgoxMDAgNzAwIFRkCihIZWxsbyBXb3JsZCkgVGoKRVQKZW5kc3RyZWFtCmVuZG9iagp4cmVmCjAgNgowMDAwMDAwMDAwIDY1NTM1IGYgCjAwMDAwMDAwMDkgMDAwMDAgbiAKMDAwMDAwMDA1NCAwMDAwMCBuIAowMDAwMDAwMTAxIDAwMDAwIG4gCjAwMDAwMDAxNzAgMDAwMDAgbiAKMDAwMDAwMDI0NCAwMDAwMCBuIAp0cmFpbGVyCjw8Ci9TaXplIDYKL1Jvb3QgMSAwIFIKPj4Kc3RhcnR4cmVmCjM0MQolJUVPRg==",
  "docName": "output.pdf"
}

非同期処理の場合：

{
  "docContent": "JVBERi0xLjQKJeLjz9MK...",
  "docName": "output.pdf",
  "async": true
}

コードサンプル​

の PDF4me フォームデータを抽出する PDF REST API 複数のプログラミング言語のコードサンプルを提供します。開発環境に最適な言語を選択してください。

C# (CSharp) サンプル

完了 C# フォームデータを抽出する実装 PDF:

フォームデータ抽出機能​

現場分析機能​

  • 完全なフィールド検出: 非表示フィールドや計算フィールドを含むすべてのフォームフィールドを特定します
  • 価値抽出すべてのフィールドタイプから現在の値とデフォルト値を抽出します。
  • 不動産分析フィールド名、型、位置、検証ルールなどのフィールドプロパティを取得します。
  • データ検証: フィールドデータの整合性とフォーマット準拠を確認する

フォーム処理​

  • PDF 形態分析: 詳細な分析 PDF 形態構造と場の関係
  • フィールドタイプの認識: さまざまなフォームフィールドタイプの自動識別
  • バッチ処理複数のフォームを処理し、複雑なフォーム構造からデータを抽出する。
  • 構造化出力: 統合しやすいように整理された構造化データを生成

高度な機能​

  • 野外調査フォームフィールドをデータベースの列またはアプリケーションフィールドにマッピングします。
  • データ変換: フォームデータをさまざまな出力形式に変換する (JSON、 XML、 CSV）
  • 検証ルールフォーム検証ルールと制約を抽出して適用する
  • プロフェッショナルな成果企業向けアプリケーションに適した高品質な抽出

業界におけるユースケースとアプリケーション​

文書管理および処理のユースケース

  • フォームデータ収集: 入力済みのデータからデータを抽出します PDF データベースストレージ用のフォーム
  • 文書のデジタル化: 紙のフォームをデジタルデータに変換する PDF 処理中
  • データ移行: 文書移行およびシステム更新時にフォームデータを抽出する
  • 形態分析フォームの入力完了率とフィールドの使用パターンを分析する

ヘルプが必要な場合​

Get Your API KeyAPI SamplesGetting Started