複数のドキュメントを生成する
生成する → 複数のドキュメントを生成する
の 複数のドキュメントを生成する API テンプレートと複数のデータ項目から複数のドキュメントを生成します。テンプレートを送信します(templateFileType、 templateFileName、 templateFileData Base64) documentDataType (Json または XML) outputType (Docx、 PDF、Word、Excel、 HTML) documentDataText または documentDataFileオプション fileMetaData そして metaDataJson、 そして async. API リターン JSON と共に outputDocuments 配列(またはポーリング) URL いつ async以下のテスターを使って試してみてください。詳細は後続のセクションをご覧ください。
複数のドキュメントを生成する API
:::注記 クイックリファレンス
終点: POST /api/v2/GenerateDocumentMultiple ・ 必須: api-key、 templateFileType、 templateFileName、 templateFileData、 documentDataType、 outputType、 documentDataText
:::
以下のフォームを使用して送信してください API キー、テンプレートファイル(Base64)、データ型、出力タイプ、およびデータ(JSON/XML (テキストまたはファイル)。応答は JSON 生成されたドキュメント付き。コードは不要です。フィールドに入力してクリックしてください。 リクエストを送信。
概要、パラメータ、および使用例
- Overview
- Parameters
- Use cases
複数ドキュメント生成とは何ですか?
このエンドポイントは、1 つのテンプレートと複数のデータレコードから複数のドキュメントを生成します (JSON または XMLテンプレート(Word、 HTML、 または PDF として Base64) documentDataType (Json または XML) outputType (Docx、 PDF、Word、Excel、 HTML)、およびデータ経由 documentDataText または documentDataFile. API データレコードごとに1つのドキュメントを生成し、それらを返送します。 outputDocuments 配列(またはポーリング) URL いつ async)
主な機能
- 1つのテンプレートで、多数のドキュメントを作成: 同じテンプレートが各データレコードにマージされます。
- テンプレートの種類: Docx、 言葉、 HTML、 または PDF (Base64)
- データ: documentDataType: Json または XML; データは documentDataText または documentDataFile。
- 出力: outputType: Docx、 PDFWord、Excel、または HTML。
- 非同期: 使用 async 大量生産向け。
:::ヒント 最適な用途 1つのテンプレートから複数の文書が必要な場合(一括レター、証明書、ラベルなど)に使用してください。1回の呼び出しで1つの文書のみが必要な場合は、 ドキュメントを生成 シングル。 :::
API パラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
| api-key | 弦 | はい | あなたの PDF4me API 鍵、 Base64 エンコードされています。 ダッシュボード。 |
| templateFileType | 弦 | はい | Docx、 言葉、 HTML、 または PDF。 |
| templateFileName | 弦 | はい | テンプレートファイル名(拡張子付き)(例:sample.docx)。 |
| templateFileData | ベース64 | はい | テンプレートファイルの内容(Base64) |
| documentDataType | 弦 | はい | Json または XML。 |
| outputType | 弦 | はい | Docx、 PDFWord、Excel、または HTML。 |
| documentDataText | 弦 | はい | JSON/XML テキストとしてデータ(もし documentDataFile 提供されていません。 |
| documentDataFile | ベース64 | いいえ | データファイル(Base64)の代替案 documentDataText。 |
| fileMetaData、 metaDataJson | 弦 | いいえ | 追加のメタデータ。 |
| async | ブール値 | いいえ | 非同期処理を有効にする。 |
複数のドキュメントを生成する場合
- 一括送付の手紙と証明書1つのテンプレートから、異なるデータ(手紙、証明書、ラベルなど)を含む複数の文書を生成します。
- 一括レポート1回のリクエストで複数のレポートを作成します。
- 大量メール送信1つのテンプレートを、受信者リストまたはデータ行と結合します。
リクエスト/レスポンスのスキーマとコードサンプルについては、以下を参照してください。 複数のドキュメントを生成する で PDF4me APIドキュメント。
前提条件
このエンドポイントを使用する前に、以下のものを用意してください。
- 有効な PDF4me API 鍵 (手に入れよう API 鍵)
- テンプレートファイル(Word、 HTML、 または PDF) で Base64 フォーマット
- データ JSON または XML フォーマット
回答形式
の API リターン JSON と outputDocuments 同期処理用に生成されたドキュメントを含む配列(200) OKまたは投票機能を提供する URL 非同期処理用 (202 Accepted)