URL 转网站截图 - 咕咕数据 API 文档

URL 生成网站截图
接口详情官网地址: https://www.gugudata.com/api/details/url2image

高效生成网页截图

请求方法: GET
接口路径: /websitetools/url2image
调试地址: https://api.gugudata.com/websitetools/url2image/demo
OpenAPI: https://www.gugudata.com/openapi/gugudata.openapi.3.1.json

请求参数:

appkey (string, 必填): 付费后获取的 APPKEY

url (string, 必填): 需要截取的网页 URL 地址

width (int, 可选): 输出截图的宽度，默认值为 250

height (int, 可选): 输出截图的高度，默认值为 250

viewportWidth (int, 可选): 渲染视窗的宽度，默认值为 1080

viewportHeight (int, 可选): 渲染视窗的高度，默认值为 1080

forceReload (boolean, 可选): 强制重新加载缓存的图片，默认值为 false

isMobile (boolean, 可选): 是否以移动设备的 User Agent 渲染，默认值为 false

isFullPage (boolean, 可选): 是否截取整个页面而非视窗裁剪，默认值为 false

isDarkMode (boolean, 可选): 是否优先采用深色模式，默认值为 false

返回字段:

DataStatus.StatusCode: 接口返回状态码

DataStatus.StatusDescription: 接口返回状态说明

DataStatus.ResponseDateTime: 接口数据返回时间

DataStatus.DataTotalCount: 此条件下的总数据量，一般用于分页计算

Data: 生成的截图图片流，可直接用于展示

HTTP 状态码:

200 接口正常响应: 业务状态码请结合响应体中的状态字段判断。

400 请求参数错误: 参数缺失、格式错误或非法组合。

401 鉴权失败: 缺少 APPKEY 或 APPKEY 无效。

403 无权限或额度不可用: 订单到期、权限不足或剩余额度不可用。

404 资源不存在: 请求路径不存在。

405 请求方法不允许: 请求方法与接口定义不匹配。

415 请求内容类型不支持: 文件上传或请求体格式不符合要求。

429 请求频率超限: 触发接口或网关限流策略。

500 服务内部异常: 服务执行异常，请联系技术支持。

502 上游依赖异常: 上游服务响应异常或暂不可用。

业务状态码:

100 正常返回: 暂无说明

101 参数错误: 暂无说明

102 请求频率受限: 每秒请求不能超过 100 次

103 账号欠费: 暂无说明

104 APPKEY 错误: 请检查传递的 APPKEY 是否为开发者中心获取到的值

110 接口响应错误: 暂无说明

接口特性:

支持全页截图和视窗截图；

支持自定义截图尺寸；

兼容移动设备截图；

支持暗黑模式截图；

固定参数请求，可以得到最新的站点截图；

快速高效的截图生成；

围绕“URL 生成网站截图”提供标准化能力，便于快速接入现有业务；

适合将“URL 生成网站截图”结果接入业务系统、后台工具和自动化流程；

全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；

全面兼容 Apple ATS；

全国多节点 CDN 部署；

接口调用状态与状态监控：https://www.gugudata.com/status。

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

接口正常响应。请求成功，业务状态请结合响应体中的自定义业务码判断。

Bodyapplication/json

示例

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

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🟠429

🔴500

🔴502