フォームフィールドを追加する PDF
フォーム → フォームフィールドを追加する PDF
の フォームフィールドを追加する PDF API フォームフィールド（テキストボックスまたはチェックボックス）を PDF 特定の位置で送信します。 PDF として Base64 （docContent) docName、 formFieldType （テキストボックスまたはチェックボックス） fieldName、 initialValue、 positionX そして positionY、 Sizeページ、オプション async. API 返します PDF 新しいフォームフィールドが追加されました。以下のテスターを使ってお試しください。詳細は以降のセクションをご覧ください。
フォームフィールドを追加してみてください PDF API
:::注記 クイックリファレンス
終点： POST /api/v2/AddFormField ・ 必須： api-key、 docContent、 docName、 initialValue、 positionX、 positionY、 fieldName、 Sizeページ、 formFieldType
:::
以下のフォームを使用して送信してください API 鍵、 PDF （Base64）、フィールドタイプ（テキストボックスまたはチェックボックス）、名前、位置、サイズ、ページ。レスポンスは PDF 新しいフォームフィールドを使用します。コードは不要です。フィールドに入力してクリックしてください。 リクエストを送信。
概要、パラメータ、および使用例
- Overview
- Parameters
- Use cases
フォームフィールドを追加するとは PDF？
このエンドポイントは、1 つ以上のフォーム フィールドを PDF 特定の位置で。 formFieldType （テキストボックスまたはチェックボックス）設定 fieldName、 initialValue、 positionX そして positionY （ページ上の座標） Size、およびページ（例：1、1-3、1、3、5、1-）。 API 返します PDF 新しい入力可能なフィールドを使用します。これを使用して静的な PDF フォームに入力するか、既存のフォームにフィールドを追加します。
主な機能
- フィールドタイプ: formFieldType: テキストボックスまたはチェックボックス。
- 位置とサイズ: positionX、 positionY （座標） Size （フィールドサイズ）
- フィールド識別子: fieldName （その分野固有の名称） initialValue （デフォルト値）
- ページターゲティングページ: 1、1-3、1、3、5、1- (1 ページ目から最後まで)。
- 非同期： 使用 async のために PDFs 多くの分野で。
:::ヒント 最適な用途 テキストボックスやチェックボックスを追加する必要がある場合に使用します PDF. ペアリング 埋める PDF 形状 フィールドに人を配置する、または フォームデータを抽出する PDF送信された値を読み込む。 :::
API パラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| api-key | 弦 | はい | あなたの PDF4me API 鍵、 Base64 エンコードされています。 ダッシュボード。 |
| docContent | ベース64 | はい | PDF ファイルの内容（Base64) |
| docName | 弦 | はい | PDF ファイル名に拡張子「.pdf」を付けます。 |
| initialValue | 弦 | はい | フォームフィールドの初期値／デフォルト値。 |
| positionX、 positionY | 整数 | はい | ページ上のフィールドのX座標とY座標。 |
| fieldName | 弦 | はい | フォームフィールドの名前（一意の識別子）。 |
| Size | 整数 | はい | フォームフィールドのサイズ。 |
| ページ | 弦 | はい | ページ: 1、1-3、1、3、5、1、3、7-10、1-。 |
| formFieldType | 弦 | はい | テキストボックス または チェックボックス。 |
| async | ブール値 | いいえ | 非同期処理を有効にする。 |
フォームフィールドの追加はいつ使用するのか PDF
- フォーム作成テキストボックスとチェックボックスを PDF 入力可能にするため。
- テンプレートテンプレートに名前付きフィールドを追加して、以下の方法で入力できるようにします。 埋める PDF 形状 または、あなたのアプリ。
- フォームの拡張既存のフィールドにフィールドを追加する PDF フォーム（例：署名日、承認チェックボックス）。
リクエスト/レスポンスのスキーマとコードサンプルについては、以下を参照してください。 PDFにフォームフィールドを追加する で PDF4me APIドキュメント。
前提条件
このエンドポイントを使用する前に、以下のものを用意してください。
- 有効な PDF4me API 鍵 （手に入れよう API 鍵）
- A PDF ドキュメント Base64 フォーマットまたはパブリック URL へ PDF ファイル
回答形式
の API を返します PDF 指定された位置にフォームフィールドが追加されたドキュメント。