URL 转网站截图

成功响应为原生 image/png 二进制，不是 Data 字符串或 JSON 包装；错误响应为 JSON。viewportWidth/viewportHeight 优先于 width/height，现有 width/height 不进行独立裁切缩放。isDarkMode 当前不改变输出。截图依赖页面可访问性和来源执行结果，不保证任意网页均可生成。普通失败可使用有效的 24 小时备用图，备用可能较旧；forceReload 不读备用。
将公开网页地址生成为 PNG 图片。
直接返回图片内容，便于应用展示。
支持页面视窗截图。
支持整页截图，便于保存长页面。
通过视窗宽度设置页面布局。
通过视窗高度设置可视区域。
支持现有移动设备模拟方式。
可使用强刷参数重新请求截图。
可用于制作网页预览图片。
可用于保存页面资料或展示材料。
可作为页面样式人工回查的图像输入。
可将同一网页不同视窗的结果用于展示对照。

当前接口契约

接口详情：https://www.gugudata.com/api/details/url2image

请求参数

参数	类型	必填	默认值	说明
appkey	string	否	无	使用已授权的 APPKEY，兼容现有有效鉴权位置。此鉴权位置可选；整体鉴权要求及其他已支持位置以本操作说明为准。
url	string	是	无	公开 HTTP/HTTPS 网页地址。
width	integer	否	250	保留现有兼容参数；viewportWidth 有值时优先使用 viewportWidth，不单独裁切或缩放图片。
height	integer	否	250	保留现有兼容参数；viewportHeight 有值时优先使用 viewportHeight。
viewportWidth	integer	否	1080	页面视窗宽度，实际截图尺寸优先采用该值。
viewportHeight	integer	否	1080	页面视窗高度；整页截图的实际高度还取决于页面内容。
forceReload	boolean	否	false	为 true 时重新请求截图，不读取备用旧结果。
isMobile	boolean	否	false	是否采用现有移动设备模拟方式。
isFullPage	boolean	否	false	是否截图整个页面；false 为页面视窗。
isDarkMode	boolean	否	false	保留兼容参数，当前不改变截图的明暗模式。

正常响应字段

字段	类型	说明
PNG 图片内容	string/binary	成功直接返回 image/png 二进制；不是 JSON 字段。

业务状态说明

业务状态码	业务状态码解释	备注
100	正常返回
101	参数错误
102	请求频率受限	默认情况下，每个接口提供 5 QPS 并发能力，可满足大多数业务场景。超出当前并发能力时，网关可能返回 429 请求频率受限；如需更高吞吐，可按需购买额外 QPS 扩展包，高频调用场景支持白名单接入与独立流控策略。
103	账号欠费
104	APPKEY 错误	请检查传递的 APPKEY 是否为开发者中心获取到的值
110	接口响应错误

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

成功返回PNG图片。

Bodyapplication/json

示例

{
  "Data": "string",
  "DataStatus": {
    "StatusCode": 0,
    "StatusDescription": "string",
    "ResponseDateTime": "string",
    "DataTotalCount": 0
  }
}

🟠400参数错误，业务码501。

🔴503依赖、处理失败或超时，业务码901。

当前接口契约#

请求参数#

正常响应字段#

业务状态说明#

请求参数

请求示例代码

返回响应

当前接口契约

请求参数

正常响应字段

业务状态说明