PDFにフォームフィールドを追加 - インタラクティブフォームAPI

PDF4me PDFにフォームフィールドを追加する インタラクティブなフォームフィールドを追加できます PDF 文書。 API サービスプロセス PDF ファイルを作成し、指定されたページの特定の位置にフォームフィールド（テキストボックスとチェックボックス）を追加します。 API 受け取る PDF コンテンツとフォームフィールドパラメータを通じて REST API 通話を利用して Base64 安全な送信のためのエンコード。柔軟な位置決め、カスタムフィールドタイプ、ページターゲティングをサポートするこのソリューションは、ドキュメントの自動化とインタラクティブな作業に最適です。 PDF 開発ワークフロー。

関連ブログ記事

この機能に関するブログ記事はまだありません。近日公開予定です。

その間、PDF4me ブログを閲覧して、あらゆるプラットフォームのチュートリアルやワークフローをご覧ください。

ブログをご覧ください →

APIリクエストの認証

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

Get your api Key

主な機能

• フォームフィールドの種類: テキストボックスとチェックボックスのフォームフィールドを追加します PDF 文書
• 精密な位置決め: 正確なX座標とY座標でフィールドの配置を制御します
• カスタムフィールドサイズ設定: フォームフィールドの寸法を設計要件に合わせて調整します
• 柔軟なページターゲティングフォームフィールドを特定のページまたはドキュメント全体に適用する
• 初期値フォームフィールドのデフォルト値を設定します
• Base64 エンコーディング: 安全なファイルコンテンツ送信 Base64 エンコーディング
• 単純 API 統合: 安らかな API 自動化向けに設計されています PDF フォーム作成ワークフロー

REST APIエンドポイント

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

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

REST APIパラメータ

PDFにフォームフィールドを追加する際のパラメータ一覧 REST APIパラメータは、理解と実装を容易にするためにカテゴリ別に整理されています。

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

パラメータ	必須	その機能	例
jobIdExt	Optional	Your own reference for this call. It is stored with the API call log so you can correlate calls with your jobs. Type: string.
integrations	Optional	Integration identifiers, forwarded unchanged with the job's notification settings. Type: array.
isAsync	Optional	Set 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
docName	Optional	Source 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
docContent	Required	The 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...
docContentBytes	Optional	Alternative raw byte payload for the source file. Type: string.
callBackUrl	Optional	Optional URL notified when an asynchronous job completes. Type: string.
fieldName	Optional	Name of the new form field. Type: string.	Input Field Name
initialValue	Optional	Initial value of the field. For a `CheckBox`, `true` or `1` creates it checked. Type: string.	New input text
positionX	Optional	Horizontal position of the field on the page. Type: integer.	300
positionY	Optional	Vertical position of the field on the page. Type: integer.	300
size	Optional	Size of the form field. Type: integer.	4
pages	Optional	Pages to add the field to, e.g. `1`, `1,3,5`, `2-5` or `1-` (1 to the last page). Type: string.	1
formFieldType	Optional	Matched case-insensitively; an unrecognised value falls back to the first entry. Type: string.	TextBox

出力

の PDF4me PDFにフォームフィールドを追加する REST API 処理モードに基づいて異なる応答を返します。 API 返します PDF として バイナリデータ 同期処理用、またはポーリング機能を提供する URL 非同期処理のため。

Success Response

同期処理（デフォルト）

いつ async 設定されていないか、 false、 API リクエストを即座に処理します。

ステータスコード: 200 OK

コンテンツタイプ: application/pdf または application/octet-stream

応答本文：

の API 返します PDF ファイルをバイナリデータとして直接保存する（ JSON)

使用方法：

1. レスポンスボディにはバイナリが含まれています PDF データ
2. 応答内容を直接保存 PDF ファイル
3. いいえ Base64 バイナリ応答にはデコードが必要です

例（JavaScript）：

const response = await fetch(url, options);
const pdfBlob = await response.blob();
// Save or process pdfBlob directly

Asynchronous Processing

非同期処理

いつ async: true 設定されている、 API リクエストを非同期的に処理します。

ステータスコード: 202 Accepted

レスポンスヘッダー:

Location: https://api.pdf4me.com/api/v2/AddFormField/poll/12345-abcde-67890

投票プロセス：

1. 抽出する Location 202レスポンスのヘッダー
2. 投票する URL 使用 GET リクエスト
3. 受信するまで投票を続けてください 200 OK 状態
4. 最終応答にはバイナリが含まれています PDF データ

投票例：

// Initial request returns 202 with Location header
const response = await fetch(url, options);
const location = response.headers.get('Location');

// Poll until complete
while (true) {
  const pollResponse = await fetch(location, { headers: { 'Authorization': 'Basic ' + apiKey } });
  if (pollResponse.status === 200) {
    const pdfBlob = await pollResponse.blob();
    // Process binary PDF
    break;
  }
  await new Promise(resolve => setTimeout(resolve, 2000)); // Wait 2 seconds
}

Error Responses

エラー応答

ステータスコード	説明	回答例
400 Bad Request	無効なリクエストパラメータ、または必須フィールドが欠落しています	{"error": "Missing required parameter: fieldName"}
401 Unauthorized	無効または欠落 API 鍵	{"error": "Unauthorized"}
500 Internal Server Error	処理中にサーバーエラーが発生しました。	{"error": "Internal server error"}

Response Format Details

反応を理解する

• 同期（200）: バイナリを返します PDF データを直接
• 非同期（202）: ポーリング用のLocationヘッダーを返します。最終的な応答はバイナリです。 PDF
• いいえ JSON ラッパー: その API リターン PDF バイナリとして、ラップされていない JSON と Base64 エンコーディング

リクエスト例

ヘッダ

Content-Type: application/json
Authorization: Basic YOUR_BASE64_ENCODED_API_KEY

注記： の API キーは Base64 エンコードします。 API 鍵から PDF4me ダッシュボード

ペイロード

{
  "docContent": "Please put PDF base64 content",
  "docName": "output.pdf",
  "initialValue": "input text",
  "positionX": 300,
  "positionY": 300,
  "fieldName": "Input Field Name",
  "Size": 4,
  "pages": "1",
  "formFieldType": "TextBox"
}

コードサンプル

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

C#

C# (CSharp) サンプル

完了 C# フォームフィールドを追加するための実装 PDF:

View C# Sample

Java

Java サンプル

Java 完全なエラー処理と応答処理を備えた実装：

View Java Sample

JavaScript

JavaScript サンプル

Node.js ブラウザ互換 JavaScript 実装：

View JavaScript Sample

Python

Python サンプル

Python requestsライブラリを使用した実装と JSON 処理:

View Python Sample

Salesforce

Salesforce サンプル

Salesforce Apex 実装 CRM 統合：

View Salesforce Sample

n8n

n8n サンプル

n8n 自動化のためのワークフロー実装：

View n8n Sample

Google Script

Google Apps Script サンプル

Google Apps Script 実装 Google Workspace 統合：

View Google Script Sample

AWS Lambda

AWS Lambda サンプル

サーバーレス AWS Lambda 関数実装:

View AWS Lambda Sample

フォームフィールド作成機能

フォームフィールドの種類

• テキストボックスのフィールドユーザーデータ入力とフォーム入力用のテキスト入力フィールドを作成します。
• チェックボックスフィールド選択と確認のオプションとしてチェックボックス要素を追加します。
• カスタムサイズ:設計要件とコンテンツのニーズに合わせてフィールドの寸法を調整します
• プロフェッショナルな成果高品質なフォームフィールド作成と正確な機能性
• 高度な処理複雑なフォームレイアウトとフィールド配置のサポート

配置とレイアウト

• 正確な座標: 正確なX座標とY座標値でフィールドの配置を制御します
• 柔軟な位置決め: あらゆるページ位置とフィールド配置に対応
• ページターゲティングフォームフィールドを特定のページまたはドキュメント全体に適用する
• カスタムサイズ最適な形状設計のための調整可能なフィールド寸法
• プロフェッショナルなレイアウト: 対象ページ全体でフォームフィールドの配置を統一する

高度な機能

• 初期値ユーザーエクスペリエンス向上のため、デフォルトのフィールド値を設定します。
• フィールド名の命名フォームデータの収集と処理のためのカスタムフィールド名
• プロフェッショナルな制作: 明確な機能性を備えた高品質なフォームフィールド生成
• 柔軟なオプション特定の要件に合わせてカスタマイズ可能なフォームフィールドパラメータ

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

Legal & Professional Services

法律・専門サービスにおけるユースケース

• 契約書式契約書や合意書に電子署名用のフォームフィールドを追加する
• 法的文書法的文書処理のためのインタラクティブなフォームを作成する
• コンプライアンスフォーム規制遵守および文書化のためのフォームを作成する
• クライアントの受け入れ法律サービスのための顧客受付フォームを作成する

Healthcare & Medical

ヘルスケアおよび医療分野における活用事例

• 患者用書類インタラクティブな患者受付フォームと病歴フォームを作成する
• 医療記録医療記録および文書作成用のフォームを作成する
• 保険金請求保険金請求処理用のフォームを設計する
• 同意書医療処置に関する同意書および承認書を作成する

Finance & Banking

金融・銀行業務におけるユースケース

• 金融アプリケーションローンおよびクレジットの申込書を作成する
• 口座開設口座開設および本人確認（KYC）手続き用のフォームを作成する
• 取引フォーム: 金融取引および処理のためのフォームを設計する
• コンプライアンス文書規制遵守報告用のフォームを作成する

Human Resources

人事関連のユースケース

• アプリケーション処理求人応募や登録のための申請フォームを作成する
• 従業員オンボーディング従業員の入社手続きと書類作成のためのフォームを作成する
• アンケート作成: インタラクティブなアンケートや質問票を設計する PDF フォーマット
• 業績評価パフォーマンス評価とフィードバックのためのフォームを作成する

Business & Enterprise

ビジネスおよび企業向けユースケース

• 文書自動化データ収集と処理のためのインタラクティブなフォームを作成する
• データ収集顧客情報とフィードバックを収集するためのフォームを作成する
• インタラクティブドキュメント既存のフォームにフォームフィールドを追加する PDFs ユーザーエンゲージメントの向上
• ビジネスプロセス自動化自動化された業務ワークフローとデータ入力のためのフォームを作成する

ヘルプが必要な場合

Get Your API KeyAPI SamplesGetting Started