网页截图
对公网 HTTP/HTTPS 网页生成安全静态截图。服务端先校验并抓取 HTML、受限样式和图片,再由本机 Chromium 离线渲染;不会执行目标网页脚本、iframe 或浏览器二次联网,因此部分依赖 JavaScript 的页面与真实浏览器效果可能不同。
补充说明
POST JSON /api/v1/endpoints/web-screenshot,Bearer API Key。参数:url、width、height、format、quality;服务器需安装 Chromium/Chrome,详细安全限制参见前台接口文档及 docs/API.md。
请求参数
除 Bearer API Key 请求头外,使用 application/json 发送以下字段。图片接口的文件需先转成纯 Base64 字符串提交。
| 字段名称 | 格式 | 说明 |
|---|---|---|
url | 字符串 | 必填,仅公网 HTTP/HTTPS 默认端口;禁止私网、环回、元数据地址 |
width | 数字 | 320—1920,默认1365 |
height | 数字 | 240—1600,默认768 |
format | 字符串 | PNG 或 JPEG |
quality | 数字 | 仅JPEG使用,40—95 |
非预期参数将被忽略;非法参数 HTTP 422。接口执行异常统一返回失败响应,不计为成功扣点。请仅提交您有权处理的文本、图片或网页内容。
示例代码
将密钥和业务字段替换为自己的实际值,不要在公开网页或 App 内写入管理员密钥。
cURL
curl -X POST "https://api.dcykjgw.com/api/v1/endpoints/web-screenshot" \
-H "Authorization: Bearer dcy_你的完整密钥" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.example.com","width":1365,"height":768,"format":"png"}'
JavaScript
fetch('https://api.dcykjgw.com/api/v1/endpoints/web-screenshot', {
method: 'POST',
headers: {'Content-Type':'application/json','Authorization':'Bearer dcy_你的完整密钥'},
body: JSON.stringify({"url":"https://www.example.com","width":1365,"height":768,"format":"png"})
}).then(r => r.json()).then(console.log);
响应结构
{
"code": 0,
"msg": "处理成功",
"platform": "web-screenshot",
"data": {"结果字段": "以实际接口返回为准"}
}图片处理成功时返回 data.image_base64、data.mime、宽高和输出字节数。其他工具直接返回数据字段或结果文本。
返回参数说明
| 字段 | 格式 | 说明 |
|---|---|---|
code | 数字 | 业务状态码,0 表示本次接口调用成功;非 0 时结合 msg 和 HTTP 状态码排查。 |
msg | 字符串 | 本次请求结果说明,成功时描述处理结果,失败时给出可读错误原因。 |
platform | 字符串 | 当前接口/平台标识,成功响应中用于区分具体接口来源。 |
data | 对象 | 接口业务数据;具体字段含义见下方本接口字段说明。 |
data.url | 字符串 | 原始请求网页 URL。 |
data.final_url | 字符串 | 安全重定向后的最终 URL。 |
data.width / data.height | 数字 | 截图宽高,单位像素。 |
data.format | 字符串 | 截图图片格式。 |
data.mime | 字符串 | 输出图片 MIME 类型。 |
data.bytes | 数字 | 截图文件字节数。 |
data.render_mode | 字符串 | 渲染模式,当前为安全静态渲染。 |
data.image_base64 | 字符串 | 截图文件 Base64 内容。 |
无效参数 HTTP 422;无效密钥 401;权限限制 403;点数不足 402;频率超限 429;服务暂不可用 503。
在线测试 · 网页截图
请填写自己的 API Key。图片只上传到当前 API 请求,不保存到浏览器本地存储;图片 Base64 在下方结果中自动隐藏。
响应结果
填写参数后点击“发送测试请求”。