JSON 转 PDF表格 API

代码示例

这些示例以 multipart/form-data 发送样例，并原样保存响应字节。请先设置环境变量 TABLECONVERT_API_KEY。

curl --fail-with-body --max-time 40 \
  'https://api.tableconvert.com/v2/convert/json-to-pdf' \
  --header "Authorization: Bearer $TABLECONVERT_API_KEY" \
  --form-string 'data=[
  {
    "item": "Notebook",
    "quantity": "12",
    "price": "4.00"
  },
  {
    "item": "Marker",
    "quantity": "8",
    "price": "3.00"
  }
]' \
  --form-string 'output[theme]=striped' \
  --form-string 'output[title]=' \
  --output 'json-to-pdf.pdf'

import os
from pathlib import Path
import requests

endpoint = "https://api.tableconvert.com/v2/convert/json-to-pdf"
headers = {"Authorization": "Bearer " + os.environ["TABLECONVERT_API_KEY"]}
fields = {
    "data": (None, "[\n  {\n    \"item\": \"Notebook\",\n    \"quantity\": \"12\",\n    \"price\": \"4.00\"\n  },\n  {\n    \"item\": \"Marker\",\n    \"quantity\": \"8\",\n    \"price\": \"3.00\"\n  }\n]"),
    "output[theme]": (None, "striped"),
    "output[title]": (None, ""),
}

response = requests.post(endpoint, headers=headers, files=fields, timeout=40)
response.raise_for_status()
Path("json-to-pdf.pdf").write_bytes(response.content)

import { writeFile } from "node:fs/promises";

const form = new FormData();
form.set("data", "[\n  {\n    \"item\": \"Notebook\",\n    \"quantity\": \"12\",\n    \"price\": \"4.00\"\n  },\n  {\n    \"item\": \"Marker\",\n    \"quantity\": \"8\",\n    \"price\": \"3.00\"\n  }\n]");
form.set("output[theme]", "striped");
form.set("output[title]", "");

const response = await fetch("https://api.tableconvert.com/v2/convert/json-to-pdf", {
  method: "POST",
  headers: { Authorization: "Bearer " + process.env.TABLECONVERT_API_KEY },
  body: form,
  signal: AbortSignal.timeout(40_000),
});
if (!response.ok) {
  throw new Error("HTTP " + response.status + ": " + await response.text());
}
await writeFile("json-to-pdf.pdf", Buffer.from(await response.arrayBuffer()));

请求参数

非空的平铺对象数组最适合表示记录输入。对象键的并集形成列；嵌套结构不会自动展平。

使用 data、file 或 url 提供一种输入来源。页面示例使用适合该格式的来源模式。

输出选项

使用API的浅色或深色样式及可选标题，将规范化记录渲染为PDF表格文档。这是数据表导出，不渲染完整HTML网页，也不编译TeX。

转换规则

输入读取方式

• 对于对象数组，列按键首次出现的顺序排列；缺少的键对应空单元格。
• null变为字面文本null，数字与布尔值在表格规范化时变为文本。
• 嵌套对象变为[object Object]；字段内数组变为逗号连接的文本，不会展开成额外行。
• 请在转换前准备明确的平铺字段；此接口没有通用flatten参数。

输出生成方式

• 请将二进制响应保存为PDF；表格由转换渲染器分页。
• 公共PDF API使用title与theme；只有theme=dark启用深色样式，其他值使用浅色表格样式。此API渲染器忽略headerColor、showHead与description。
• 请在结果中检查页面宽度、长值与字符显示支持。

适用场景

响应与错误

重试前请先检查响应。新的 HTTP 请求属于新的转换，可能再次消耗积分。

限制、计费与版本

本地预览最多接受 200 KB。当前 API 实现允许上传一个不超过 50 MiB 的文件，multipart 中每个文本字段限制为 1 MiB，v2 转换任务的截止时间为 30 秒。部署环境可能设置更严格的限制。重试前请先检查错误内容；部分解析或渲染失败会返回 HTTP 500。

真实调用遵循 API 积分规则。转换失败会返还积分；若转换已完成，随后下载连接中断不会撤销该次成功转换。

参考资料与格式规范

格式参考资料用于说明底层语法；上方转换规则与样例描述 TableConvert 的实际实现。

• www.ecma-international.org
• pdfkit.org