生成多个文档
产生 → 生成多个文档
这 生成多个文档 API 使用一个模板和多个数据项生成多个文档。您发送模板(templateFileType, templateFileName, templateFileData Base64), documentDataType (Json 或者 XML), outputType (Docx, PDFWord、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
什么是“批量生成文档”?
此端点可从一个模板和多个数据记录生成多个文档(JSON 或者 XML您提供模板(Word, HTML, 或者 PDF 作为 Base64), documentDataType (Json 或者 XML), outputType (Docx, PDFWord、Excel、 HTML),以及通过以下方式获得的数据 documentDataText 或者 documentDataFile。 这 API 每个数据记录生成一个文档并返回。 outputDocuments 数组(或轮询) URL 什么时候 async)。
主要特点
- 一个模板,多个文档:同一模板与每条数据记录合并。
- 模板类型: Docx, 单词, HTML, 或者 PDF (Base64)。
- 数据: documentDataType: Json 或者 XML;数据在 documentDataText 或者 documentDataFile。
- 输出: outputType: Docx, PDFWord、Excel 或 HTML。
- 异步: 使用 async 适用于大批量生产。
:::提示 最佳用途
当您需要使用同一模板生成多个文档时(例如批量信函、证书、标签)。如果每次通话仅需生成一个文档,请使用其他模板。 生成单个文档.
:::
API 参数
| 范围 | 类型 | 必需的 | 描述 |
|---|---|---|---|
| api-key | 细绳 | 是的 | 你的 PDF4me API 钥匙, Base64 已编码。从……获取 仪表板。 |
| templateFileType | 细绳 | 是的 | Docx, 单词, HTML, 或者 PDF。 |
| templateFileName | 细绳 | 是的 | 带扩展名的模板文件名(例如 sample.docx)。 |
| templateFileData | base64 | 是的 | 模板文件内容(Base64)。 |
| documentDataType | 细绳 | 是的 | Json 或者 XML。 |
| outputType | 细绳 | 是的 | Docx, PDFWord、Excel 或 HTML。 |
| documentDataText | 细绳 | 是的 | JSON/XML 数据以文本形式(如果) documentDataFile (未提供)。 |
| documentDataFile | base64 | 不 | 数据文件(Base64),替代方案 documentDataText。 |
| fileMetaData, metaDataJson | 细绳 | 不 | 附加元数据。 |
| async | 布尔值 | 不 | 启用异步处理。 |
先决条件
使用此端点之前,请确保您已具备以下条件:
- 有效的 PDF4me API 钥匙 (获得你的 API 钥匙)
- 模板文件(Word文档) HTML, 或者 PDF) 在 Base64 格式
- 数据 JSON 或者 XML 格式
回复格式
这 API 返回 JSON 和 outputDocuments 包含用于同步处理的已生成文档的数组(200) OK或提供轮询 URL 用于异步处理(202) Accepted)。