跳到主要内容
PDF4me API集成知识库扩展API 测试员博客

生成文档（单个）

此端点的作用

PDF4me 生成文档（单个） 通过合并模板（Word、 HTML， 或者 PDF带有数据有效载荷（JSON， XML， 或者 CSV) 在一个 REST 调用。模板可以是 Base64一个公共的 URL或原始 HTML数据可以是行内文本，也可以是…… Base64编码文件，或一个 URL返回渲染后的结果 PDF， Docx， 或者 HTML 以二进制形式 (200) 或通过 Location-header 轮询 URL （202）

相关博客文章
目前尚无关于此功能的博客文章——敬请期待。
在此期间，您可以浏览 PDF4me 博客，查看适用于各平台的教程和工作流程。
访问博客 →

验证您的身份 API 要求​

每一个 PDF4me REST 通话必须包含您的 API 关键在于 Authorization 请求头设置为基本身份验证。请从开发者控制面板获取或轮换您的密钥。

Get your API Key

端点​

邮政/api/v2/GenerateDocumentSingle

您不容错过的重要事实​

任何一个 文档数据文本 或者 文档数据文件
只能设置一个数据源，不能同时设置两个数据源及其内容。 文档数据文本 内联 JSON / XML / CSV。 使用 文档数据文件 为 Base64编码数据文件或公共 URL。
允许的输出类型取决于模板文件类型
Docx、邮件合并、Google Docs 接受 PDF 或者 DocxHTML接受 HTML 仅接受 PDF 文件。 PDF 仅限大小写。务必注意大小写。
异步返回 202 + Location 标头
和 IsAsync: true 这 API 可能会响应 202 和 Location 标头。 GET 那 URL （相同的授权）直到 200 秒，并附带渲染文件（标准） pdf4meAsyncRequest 图案）。

HTTP 设置​

方法： 邮政
URL： https://api.pdf4me.com/api/v2/GenerateDocumentSingle
内容类型： application/json
授权： 基本 <您的 PDF4me API 键>

发送 IsAsync: true 在体内。 200 返回渲染后的文件字节。 202 返回一个 地点 带有投票的标题 URL； GET 那 URL 使用相同的 Authorization 标头，直到 200。

变异矩阵（与 Postman 相关）​

选择一种模板变体（T1/T2/T3）和一种数据变体（D1/D2/D3）。六种组合涵盖所有调用。

模板 （templateFileData）​

代码来源Postman 的价值 templateFileData也需要
T1Base64Base64 template file (strip data:...;base64, prefix if present)templateFileName
T2URLFull HTTPS URL string (not downloaded by the API request body)templateFileName
T3HTML codeBase64-encoded UTF-8 HTML: Buffer.from(html, "utf8").toString("base64")templateFileName, templateFileType: HTML

文档数据（二选一） API 字段）​

代码来源API字段邮递员的价值
D1TextdocumentDataTextRaw JSON / XML / CSV string
D2Base64documentDataFileBase64 of the data file (strip data-URL prefix if present)
D3URLdocumentDataFileFull HTTPS URL to .json / .xml / .csv

规则： 恰好一个 文档数据文本 或者 文档数据文件 必须设置。从正文中省略未使用的字段。

常见组合​

#模板数据典型用途
1T1 Docx base64D1 JSON textWord mail-merge to PDF
2T2 Docx URLD3 JSON URLHosted template + hosted data
3T3 HTMLD1 JSON textHTML mustache rendered to HTML / PDF
4T1 PDF formD2 JSON base64PDF template + encoded data file
5T2 MailMerge URLD1 XML textWord merge fields + inline XML

templateFileType → 允许的输出类型​

模板文件类型允许 输出类型笔记
DocxPDF, DocxPDF4me Word template
MailMergePDF, DocxMail merge Word
GoogleDocsPDF, DocxGoogle Docs export style
HTMLHTML onlyMustache in HTML
PDFPDF onlyPDF form / template

API 身体场​

总是发送​

场地必需的类型笔记
templateFileTypeYesstringDocx, HTML, PDF, MailMerge, GoogleDocs
templateFileNameYesstringWith extension, e.g. template.docx, template.html, template.pdf
templateFileDataYesstringBase64 template, or template URL string
documentDataTypeYesstringJson, XML, or Csv (exact casing)
outputTypeYesstringPDF, Docx, or HTML (see allowed-output table above)
IsAsyncYesbooleantrue

文档数据（一条路径）​

场地需要类型笔记
documentDataTextD1 (text)stringValid JSON when documentDataType is Json; XML must look like XML; CSV non-empty
documentDataFileD2 or D3stringBase64 data file or URL to data file

选修的​

场地什么时候默认
KeepPdfEditableoutputType is PDFfalse
documentDataFileD1 text path is usedOmitted
documentDataTextD2 or D3 path is usedOmitted

验证规则​

查看细节
Template URLNon-empty, valid URL.
Template base64Non-empty after optional data-URL strip.
HTML codeOnly when templateFileType is HTML. Empty is rejected. Auto-wraps <html> if missing.
JSON textMust parse successfully with JSON.parse.
XML textMust start with < and contain >.
CSV textNon-empty after trim.
Either data sourcedocumentDataFile or documentDataText is required.

占位符样本​

物品例子
Template URL (Docx)https://example.com/template.docx
Template nametemplate.docx / template.html / template.pdf
Data URL (JSON)https://example.com/data.json
Data file namedata.json
JSON text{"name": "John Doe", "email": "[email protected]", "items": [{"product": "Widget", "price": 29.99}]}
XML text<?xml version="1.0"?><root><name>John Doe</name></root>
CSV textname,email\nJohn Doe,[email protected]
HTML template<!DOCTYPE html>...{{title}}...

示例有效载荷​

1. Word模板（base64编码）+ JSON 文本 → PDF​

{
 "templateFileType": "Docx",
 "templateFileName": "template.docx",
 "templateFileData": "UEsDBBQAAAAI...",
 "documentDataType": "Json",
 "documentDataText": "{\"name\": \"John Doe\", \"email\": \"[email protected]\", \"items\": [{\"product\": \"Widget\", \"price\": 29.99}]}",
 "outputType": "PDF",
 "KeepPdfEditable": false,
 "IsAsync": true
}

2. Word模板（URL）+ JSON 数据 （URL）→ PDF​

{
 "templateFileType": "Docx",
 "templateFileName": "template.docx",
 "templateFileData": "https://example.com/template.docx",
 "documentDataType": "Json",
 "documentDataFile": "https://example.com/data.json",
 "outputType": "PDF",
 "KeepPdfEditable": false,
 "IsAsync": true
}

3. Word模板（base64编码）+ JSON 数据（base64）→ Word 输出​

documentDataFile 包含 base64 编码的 JSON 文件字节（不是已解析的对象）。

{
 "templateFileType": "Docx",
 "templateFileName": "template.docx",
 "templateFileData": "UEsDBBQAAAAI...",
 "documentDataType": "Json",
 "documentDataFile": "eyJuYW1lIjogIkpvaG4gRG9lIn0=",
 "outputType": "Docx",
 "IsAsync": true
}

4. HTML 模板（base64 编码） HTML 文件）+ JSON 文本 → HTML​

原始 HTML 在 Postman 中，发送相同的有效负载 n8n 节点将进行 base64 编码 HTML 在 templateFileData。

{
 "templateFileType": "HTML",
 "templateFileName": "template.html",
 "templateFileData": "PCFET0NUWVBFIGh0bWw+...",
 "documentDataType": "Json",
 "documentDataText": "{\"title\": \"Invoice\", \"heading\": \"Hello\", \"content\": \"World\"}",
 "outputType": "HTML",
 "IsAsync": true
}

5. 邮件合并（URL）+ XML 文本 → PDF​

{
 "templateFileType": "MailMerge",
 "templateFileName": "template.docx",
 "templateFileData": "https://example.com/template.docx",
 "documentDataType": "XML",
 "documentDataText": "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root><name>John Doe</name><email>[email protected]</email></root>",
 "outputType": "PDF",
 "IsAsync": true
}

6. PDF 表单模板（base64）+ CSV 文本 → PDF （可编辑）​

{
 "templateFileType": "PDF",
 "templateFileName": "template.pdf",
 "templateFileData": "JVBERi0xLjQKJcfsj6IK...",
 "documentDataType": "Csv",
 "documentDataText": "name,email\nJohn Doe,[email protected]",
 "outputType": "PDF",
 "KeepPdfEditable": true,
 "IsAsync": true
}

7. Google Docs 风格（base64）+ JSON URL → Docx​

{
 "templateFileType": "GoogleDocs",
 "templateFileName": "template.docx",
 "templateFileData": "UEsDBBQAAAAI...",
 "documentDataType": "Json",
 "documentDataFile": "https://example.com/data.json",
 "outputType": "Docx",
 "IsAsync": true
}

邮递员收款小贴士​

Body
Use raw JSON. The API does not accept form-data for this endpoint.
Base64 of data
For D2, base64-encode the whole .json / .xml / .csv file and put it in documentDataFile. Set documentDataType accordingly.
HTML template
For T3 in Postman: Buffer.from(html, "utf8").toString("base64"). Send the base64 in templateFileData with templateFileType: HTML.
Filename match
Match the extension in templateFileName to templateFileType: .docx for Word / MailMerge / GoogleDocs, .html for HTML, .pdf for PDF.
Save response
Save the response body as .pdf, .docx, or .html depending on outputType.

curl 示例​

curl -X POST https://api.pdf4me.com/api/v2/GenerateDocumentSingle \
 -H "Content-Type: application/json" \
 -H "Authorization: Basic YOUR_API_KEY" \
 -d '{
 "templateFileType": "Docx",
 "templateFileName": "template.docx",
 "templateFileData": "https://example.com/template.docx",
 "documentDataType": "Json",
 "documentDataFile": "https://example.com/data.json",
 "outputType": "PDF",
 "KeepPdfEditable": false,
 "IsAsync": true
 }' \
 --output generated.pdf

快速参考：按变体划分的必需项与可选项​

场地T1+D1T2+D3T1+D2T3+D1任何 PDF 输出
templateFileTypeReqReqReqReqReq
templateFileNameReqReqReqReqReq
templateFileDataReq (b64)Req (URL)Req (b64)Req (b64 HTML)Req
documentDataTypeReqReqReqReqReq
outputTypeReqReqReqReqReq
documentDataTextReqOmitOmitReqOmit
documentDataFileOmitReq (URL)Req (b64)OmitOmit
IsAsyncReqReqReqReqReq
KeepPdfEditableOptOptOptN/A*Opt if PDF

*KeepPdf可编辑 仅适用于 输出类型 是 PDF; 这 API 否则会造成错误。

代码示例​

常问问题​

Can I send both documentDataText and documentDataFile in one request?+
No. Exactly one data source must be set. Omit the unused field. Sending both with content is rejected by the validation layer.
Which output types are allowed for each templateFileType?+
Docx, MailMerge, and GoogleDocs accept PDF or Docx. HTML accepts HTML only. PDF accepts PDF only. The casing of outputType matters.
Does KeepPdfEditable apply to every request?+
No. It only applies when outputType is PDF. For HTML or Docx output the API forces false and ignores the flag.
How do I send raw HTML in Postman?+
Base64-encode the UTF-8 HTML string (Buffer.from(html, "utf8").toString("base64") or the equivalent in your language). Put the result in templateFileData with templateFileType: HTML.
How do I encode the data file for D2?+
Base64-encode the entire .json, .xml, or .csv file bytes, not the parsed object. Put the base64 string in documentDataFile and set documentDataType to match.
How does the async flow work?+
Send IsAsync true. If the API returns 200, the rendered file is in the body. If 202, read the Location header for a poll URL. GET that URL with the same Authorization. Poll until 200.
My template Base64 has a data: prefix. Do I strip it?+
Yes. The API expects raw Base64 in templateFileData. Strip any data:...;base64, prefix before posting. Same applies to documentDataFile.
What extension should the response file have?+
Match outputType: .pdf for PDF, .docx for Docx, .html for HTML.

相关行动​

在其他平台上执行相同的任务​

获取帮助​

Get Your API KeyAll Code SamplesAPI Reference