网站截图与 HTML 快照 - 咕咕数据 API 文档

网站截图与 HTML 快照
接口详情官网地址: https://www.gugudata.com/api/details/url2snapshot

通过网页 URL 获取站点截图与内容

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

请求参数:

url (string, 必填): 需要截图的网页 URL 地址，必须是有效的 HTTP 或 HTTPS 链接

responseFormat (string, 可选): 返回格式，可选值：base64（返回 base64 编码的图片数据）、url（返回图片 URL 链接）

fullPage (boolean, 可选): 是否截取完整页面，true 为全页面截图，false 为可视区域截图

width (int, 可选): 截图宽度，单位像素，范围：320-3840

height (int, 可选): 截图高度，单位像素，范围：240-2160

deviceScaleFactor (float, 可选): 设备像素比，影响截图清晰度，范围：1-3

userAgent (string, 可选): 用户代理字符串，用于模拟不同的浏览器

isMobile (boolean, 可选): 是否模拟移动设备，true 为移动设备模式，false 为桌面模式

返回字段:

DataStatus.StatusCode: 接口返回状态码，100 为成功

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

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

DataStatus.DataTotalCount: 此条件下的总数据量，一般为1

Data.Image: 截图图片，当responseFormat为base64时返回base64编码的图片数据，为url时返回图片链接

Data.Content: 网页文本内容，提取的网页主要文本信息

HTTP 状态码:

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

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

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

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

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

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

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

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

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

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

业务状态码:

100 正常返回: 暂无说明

101 参数错误: URL 参数为空或格式错误

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

103 账号欠费: 暂无说明

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

110 网页截图失败: 网页无法访问、加载超时或截图服务异常

111 图片上传失败: 当responseFormat为url时，图片上传到CDN失败

接口特性:

支持任意网页 URL 高质量截图，包括动态内容和 JavaScript 渲染页面；

支持全页面截图和可视区域截图两种模式；

可自定义截图尺寸、设备像素比等参数；

支持桌面端和移动端设备模拟；

同时返回截图图片和网页文本内容；

支持 base64 编码和 CDN URL 两种返回格式；

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

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

全接口支持 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": {
        "Image": "string",
        "Content": "string"
    }
}

🟠400

🟠401

🟠403

🟠404

🟠405

🟠415

🟠429

🔴500

🔴502