转变 URL 到 PDF
转变 → 转变 URL 到 PDF
这 转变 URL 到 PDF API 将网页转换为 URL 变成一个 PDF你发送 webUrl, authType (无需授权/基本授权),可选 用户名/密码, docContent (为空) URL 转换), docName, 布局, 格式, 规模边距, printBackground, displayHeaderFooter, 和 IsAsync。 这 API 返回 PDF (或 202 + Location 为了 async请使用下面的测试工具进行尝试;更多详情请参见后续章节。
尝试转换 URL 到 PDF API
:::备注 快速参考
终点: POST /api/v2/ConvertUrlToPdf · 必需的: api-key, webUrl, authType, docContent, docName布局、格式、比例、边距 printBackground, displayHeaderFooter, IsAsync
:::
使用下方表格提交您的 API 密钥,网络 URL,身份验证(如果需要),输出名称,布局,格式,缩放比例,边距和选项。响应是: PDF (或民意调查) URL 什么时候 async无需编写代码,只需填写字段并点击即可。 发送请求.
概述、参数和用例
- Overview
- Parameters
- Use cases
什么是转换 URL 到 PDF?
此端点转换实时网页(URL) 进入一个 PDF您提供 webUrl, authType (无需身份验证或基本身份验证;如果是基本身份验证,则需要用户名/密码) docName, 布局 (竖幅/风景) 格式 (A0-A8 等) 规模边距, printBackground, displayHeaderFooter, 和 IsAsync。 这 API 捕获页面(CSS(图像、布局)并返回 PDF 或 Location URL 为了 async。
主要特点
- 居住 URL获取并渲染页面 webUrl。
- 身份验证: 无授权 或者 基本的 (用户名/密码)用于受保护的页面。
- 布局和格式:与“转换”选项相同 HTML 到 PDF (布局、格式、比例、边距)。
- 异步: IsAsync 返回 202 Location URL 用于民意调查。
提示:最适合
当你需要时使用 PDF 实时网页(例如文章、仪表盘)。静态网页。 HTML 内容使用 转变 HTML 到 PDF.
:::
API 参数
| 范围 | 类型 | 必需的 | 描述 |
|---|---|---|---|
| api-key | 细绳 | 是的 | 你的 PDF4me API 钥匙, Base64 已编码。从……获取 仪表板。 |
| webUrl | 细绳 | 是的 | 网站 URL 要转换的页面(例如 https://example.com)。 |
| authType | 细绳 | 是的 | 无授权 或者 基本的。 |
| 用户名, 密码 | 细绳 | 不 | 用于基本身份验证。 |
| docContent | 细绳 | 是的 | 请留空。 URL 转换。 |
| docName | 细绳 | 是的 | 输出 PDF 文件名。 |
| 布局 | 细绳 | 是的 | 肖像 或者 景观。 |
| 格式 | 细绳 | 是的 | 页面格式(A0-A8、Tabloid、Legal 等)。 |
| 规模 | 数字 | 是的 | 比例因子(例如 1.0 = 100%)。 |
| topMargin, leftMargin, rightMargin, bottomMargin | 细绳 | 是的 | 边距(例如 20px)。 |
| printBackground, displayHeaderFooter | 布尔值 | 是的 | 包含背景;显示页眉/页脚。 |
| IsAsync | 布尔值 | 是的 | 启用异步处理。 |
何时使用 Convert URL 到 PDF
- 文章和页面将网页或文章另存为 PDF。
- 仪表盘捕获实时仪表板或报告 URL 作为 PDF。
- 存档创建一个 PDF 快照 URL 存档。
需要完整信息 API?
有关请求/响应模式和代码示例,请参阅 转变 URL 到 PDF 在 PDF4me API 文档。
:::
先决条件
使用此端点之前,请确保您已具备以下条件:
- 有效的 PDF4me API 钥匙 (获得你的 API 钥匙)
- 一个有效的网站 URL 转换
回复格式
这 API 返回一个 PDF 文档:
- 状态 200: URL 到 PDF 转换立即完成 - 二进制 PDF 回复正文中的内容
- 状态 202请求已接受并异步处理 - 请使用 Location 标题 URL 投票表决结果
对于异步请求,轮询 Location URL 直到返回状态码 200 为止 PDF 文档。