Docs Render API

Generate PDFs from Google Docs templates using dynamic data.

原始信息汇总

Docs Render API 数据集概述

数据集基本信息

• 数据集名称: Docs Render API
• 数据集类别: Business Software
• 数据集提供方: Ghost Productions
• 数据集订阅数: 4
• 数据集评分: 9.2 Popularity
• 服务等级: 88% Service Level
• 平均延迟: 1785ms
• 测试通过率: 100%

数据集定价方案

• BASIC: $0.00 / 月
• PRO: $10.00 / 月
• ULTRA: $29.00 / 月

数据集核心功能

• 允许用户使用动态数据从 Google Docs 模板生成 PDF。
• 适用于：发票、合同、证书、报告、信件。
• 无需前端，可在几分钟内实现文档自动化。

数据集工作原理

1. 创建一个带有 {{placeholders}} 的 Google Docs 模板。
2. 将 JSON 数据发送到 API。
3. 接收生成的 PDF。

数据集使用指南

快速开始

1. 订阅并获取密钥：在 RapidAPI 上订阅 API 后，将自动收到 X-RapidAPI-Key。在所有请求的 Header 中包含此密钥。

2. 准备模板并获取 ID：

   • 创建 Google 文档，并使用双花括号添加变量（例如 {{name}}、{{date}}）。
   • 从 URL 中获取 ID（/d/ 和 /edit 之间的长字符串）。

3. 注册模板（创建别名）：

   • 端点: POST /templates
   • 请求体示例: json { "key": "invoice-v1", "google_doc_id": "1AbC...YourLongGoogleDocID" }

4. 渲染文档：

   • 端点: POST /docs/render
   • 请求体示例: json { "template": "invoice-v1", "variables": { "name": "Jane Doe", "date": "2024-02-14" } }

数据集端点参考

POST /templates

• 功能: 注册新的模板别名。
• 请求体参数:
  • key (字符串): 模板的自定义别名（例如 "contract_2024"）。
  • google_doc_id (字符串): Google 文档 URL 中的 ID。

POST /docs/render

• 功能: 从 Google 文档模板生成 PDF。
• 请求体参数:
  • template (字符串): 在步骤 3 中注册的别名键。
  • variables (对象): 与文档中 {{placeholders}} 匹配的键值对。
  • output_title (字符串，可选): 输出文件的名称。
  • return (字符串，可选): pdf_stream（二进制，默认）或 pdf_base64。
• 请求示例: bash curl --request POST --url https://docs-render-api.p.rapidapi.com/docs/render --header Content-Type: application/json --header X-RapidAPI-Key: YOUR_KEY --header X-RapidAPI-Host: docs-render-api.p.rapidapi.com --data { "template": "invoice-v1", "variables": { "client": "Acme Corp", "amount": "$500.00" } }

GET /health

• 功能: 检查 API 是否可操作。

数据集常见问题解答

• 是否需要验证 Google 账户？：不需要。只需提供 Google 文档模板的 ID，API 会安全地处理渲染。
• 如何格式化变量？：在 Google 文档中使用 {{variable_name}}。API 将用 JSON 请求体中提供的值替换此文本。
• 是否可以自定义输出文件名？：可以。在请求体中添加 output_title 参数（例如 "output_title": "Invoice_123"）。
• 如何获取文件内容（二进制与 Base64）？：默认情况下，API 返回二进制 PDF 流 (pdf_stream)。如果需要将文件作为 JSON 字符串（例如用于前端显示），请在请求体中设置 "return": "pdf_base64"。
• 如果缺少变量会怎样？：文档中任何未在 JSON 请求体中提供的 {{variables}} 将在最终 PDF 中保留为纯文本。JSON 中任何额外的变量将被忽略。
• 模板未找到（404 错误）？：请仔细检查是否从 URL 中复制了正确的 Google 文档 ID（/d/ 和 /edit 之间的字符串）。同时确保文档使用标准的 Google 文档权限。