生成单个文档
产生 → 生成单个文档
这 生成单个文档 API 根据模板和数据生成一份文档。您发送模板（templateFileType， templateFileName， templateFileData Base64）， documentDataType （文本， JSON， XML）， outputType （html， PDF（Word、Excel）， documentDataText 或者 documentDataFile， 选修的 fileMetaData 和 metaDataJson， 和 async。 这 API 返回生成的文档（二进制或轮询） URL请使用下面的测试工具进行尝试；更多详情请参见后续章节。
尝试使用“生成单个文档”功能 API
:::备注 快速参考
终点： POST /api/v2/GenerateDocumentSingle · 必需的： api-key， templateFileType， templateFileName， templateFileData， documentDataType， outputType， documentDataText
:::
使用下方表格提交您的 API 密钥，模板文件（Base64）、数据类型、输出类型和数据（JSON/XML （文本或文件）。响应内容为生成的文档。无需编写代码，只需填写字段并点击即可。 发送请求.
概述、参数和用例
- Overview
- Parameters
- Use cases
什么是“生成单个文档”？
此端点根据模板（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 适用于大型模板或数据。
:::提示 最佳用途
当每次通话只需要一份文件（发票、信函、报告）时使用。如果需要使用同一个模板生成多份文件，请使用其他模板。 生成多个文档.
:::
API 参数
| 范围 | 类型 | 必需的 | 描述 |
|---|---|---|---|
| api-key | 细绳 | 是的 | 你的 PDF4me API 钥匙， Base64 已编码。从……获取 仪表板。 |
| templateFileType | 细绳 | 是的 | html、Word、 PDF， HTML， 或者 DOCX。 |
| templateFileName | 细绳 | 是的 | 模板文件名（带扩展名）（例如 invoice_template.html）。 |
| templateFileData | base64 | 是的 | 模板文件内容（Base64）。 |
| documentDataType | 细绳 | 是的 | 文本， JSON， 或者 XML。 |
| outputType | 细绳 | 是的 | html， PDFWord、Excel 或 HTML。 |
| documentDataText | 细绳 | 是的 | JSON/XML 数据以文本形式（如果） documentDataFile （未提供）。 |
| documentDataFile | base64 | 不 | 数据文件（Base64），替代方案 documentDataText。 |
| fileMetaData， metaDataJson | 细绳 | 不 | 附加元数据。 |
| async | 布尔值 | 不 | 启用异步处理。 |
先决条件
使用此端点之前，请确保您已具备以下条件：
- 有效的 PDF4me API 钥匙 （获得你的 API 钥匙）
- 模板文件（Word文档） HTML， 或者 PDF） 在 Base64 格式
- 数据 JSON 或者 XML 格式
回复格式
这 API 返回生成的文档作为二进制数据，用于同步处理（200） OK或提供轮询 URL 用于异步处理（202） Accepted）。