ドキュメントを生成 シングル

生成する → ドキュメントを生成 シングル

の ドキュメントを生成 シングル API テンプレートとデータから 1 つのドキュメントを生成します。テンプレートを送信します (templateFileType、 templateFileName、 templateFileData Base64) documentDataType （文章、 JSON、 XML) outputType (html、 PDF（Word、Excelなど） documentDataText または documentDataFileオプション fileMetaData そして metaDataJson、 そして async. API 生成されたドキュメント (バイナリまたはポーリング) を返します URL以下のテスターを使って試してみてください。詳細は後続のセクションをご覧ください。

ドキュメントを1つ生成してみてください API

:::注記 クイックリファレンス 終点： POST /api/v2/GenerateDocumentSingle ・ 必須： api-key、 templateFileType、 templateFileName、 templateFileData、 documentDataType、 outputType、 documentDataText :::

ライブで試してみましょう

以下のフォームを使用して送信してください API キー、テンプレートファイル（Base64）、データ型、出力タイプ、およびデータ（JSON/XML テキストまたはファイル）。応答は生成されたドキュメントです。コードは不要です。フィールドに入力してクリックしてください。 リクエストを送信。

Loading API Tester...

概要、パラメータ、および使用例

Overview

ドキュメント生成（Generate Document Single）とは何ですか？

このエンドポイントは、テンプレート (Word、 HTML、 または PDF）とデータ（JSON または XMLテンプレートファイルを提供します（Base64) templateFileType そして templateFileName、 documentDataType （文章、 JSON、 XML) outputType (html、 PDF、Word、Excel）、およびデータ documentDataText または documentDataFile. API データをテンプレートにマージし、生成されたドキュメントを返します。オプションを使用します。 fileMetaData そして metaDataJson 追加のメタデータ用。

主な機能

• テンプレートの種類： 言葉、 HTML、 または PDF テンプレート（Base64)
• データ: documentDataType： 文章、 JSON、 または XML; データは documentDataText または documentDataFile （Base64)
• 出力: outputType: html、 PDFWord、またはExcel。
• 非同期： 使用 async 大規模なテンプレートやデータの場合。

:::ヒント 最適な用途 1回の通話につき1つの文書が必要な場合（請求書、手紙、レポートなど）。1つのテンプレートから複数の文書を作成する場合は、 複数のドキュメントを生成する。 :::

Parameters

API パラメータ

パラメータ	タイプ	必須	説明
api-key	弦	はい	あなたの PDF4me API 鍵、 Base64 エンコードされています。 ダッシュボード。
templateFileType	弦	はい	HTML、Word、 PDF、 HTML、 または DOCX。
templateFileName	弦	はい	テンプレートファイル名（拡張子付き）（例：invoice_template.html）。
templateFileData	ベース64	はい	テンプレートファイルの内容（Base64)
documentDataType	弦	はい	文章、 JSON、 または XML。
outputType	弦	はい	HTML、 PDFWord、Excel、または HTML。
documentDataText	弦	はい	JSON/XML テキストとしてデータ(もし documentDataFile 提供されていません。
documentDataFile	ベース64	いいえ	データファイル（Base64）の代替案 documentDataText。
fileMetaData、 metaDataJson	弦	いいえ	追加のメタデータ。
async	ブール値	いいえ	非同期処理を有効にする。

Use cases

ドキュメント生成シングルを使用するタイミング

• 請求書と手紙テンプレート（請求書、契約書、手紙）ごとに、結合されたデータを含む文書を1つ生成します。
• 報告書テンプレートから単一のレポートを作成し、 JSON/XML データ。
• 証明書: 呼び出しごとに証明書またはドキュメントを1つ生成します。

フルが必要API？

リクエスト/レスポンスのスキーマとコードサンプルについては、以下を参照してください。 ドキュメントを生成 シングル で PDF4me APIドキュメント。

前提条件

このエンドポイントを使用する前に、以下のものを用意してください。

• 有効な PDF4me API 鍵 （手に入れよう API 鍵）
• テンプレートファイル（Word、 HTML、 または PDF） で Base64 フォーマット
• データ JSON または XML フォーマット

回答形式

の API 生成されたドキュメントを同期処理用のバイナリデータとして返します (200 OKまたは投票機能を提供する URL 非同期処理用 (202 Accepted)

ヘルプが必要な場合

Get Your API KeyFull DocumentationAPI Tester Home