# 网站截图与 Html 快照 Api 接口

网站截图与 HTML 快照 API 接口

网站工具 通过网页 URL 获取站点截图与内容 网页截图 / 网页快照 网站工具 / 截图

![gugudata api](https://static.gugudata.com/api-covers_url_to_snapshot.png align="left")

## **1\. 产品功能**

* 支持任意网页 URL 高质量截图，包括动态内容和 JavaScript 渲染页面；
    
* 支持全页面截图和可视区域截图两种模式；
    
* 可自定义截图尺寸、设备像素比等参数；
    
* 支持桌面端和移动端设备模拟；
    
* 同时返回截图图片和网页文本内容；
    
* 支持 base64 编码和 CDN URL 两种返回格式；
    
* 全接口支持 HTTPS（TLS v1.0 / v1.1 / v1.2 / v1.3）；
    
* 全面兼容 Apple ATS；
    
* 全国多节点 CDN 部署；
    
* 接口极速响应，多台服务器构建 API 接口负载均衡；
    
* [接口调用状态与状态监控](https://www.gugudata.com/status)
    

# **2\. API 文档**

**接口详情:** [https://www.gugudata.com/api/details/url2snapshot](https://www.gugudata.com/api/details/url2snapshot)

**接口地址:** [https://api.gugudata.com/websitetools/url2snapshot?appkey=](https://api.gugudata.com/websitetools/url2snapshot?appkey=){{appkey}}

**返回格式:** application/json; charset=utf-8

**请求方式:** POST

**请求协议:** HTTPS

**请求示例:** [https://api.gugudata.com/websitetools/url2snapshot](https://api.gugudata.com/websitetools/url2snapshot)

**数据预览:** [https://www.gugudata.com/preview/url2snapshot](https://www.gugudata.com/preview/url2snapshot)

**接口测试:** [https://api.gugudata.com/websitetools/url2snapshot/demo](https://api.gugudata.com/websitetools/url2snapshot/demo)

# **3\. 请求参数**

| **参数名** | **参数类型** | **是否必须** | **默认值** | **备注** |
| --- | --- | --- | --- | --- |
| url | string | 是 | [https://www.example.com](https://www.example.com) | 需要截图的网页 URL 地址，必须是有效的 HTTP 或 HTTPS 链接 |
| responseformat | string | 否 | base64 | 返回格式，可选值：base64（返回 base64 编码的图片数据）、url（返回图片 URL 链接） |
| fullpage | boolean | 否 | true | 是否截取完整页面，true 为全页面截图，false 为可视区域截图 |
| width | int | 否 | 1920 | 截图宽度，单位像素，范围：320-3840 |
| height | int | 否 | 1080 | 截图高度，单位像素，范围：240-2160 |
| devicescalefactor | float | 否 | 1 | 设备像素比，影响截图清晰度，范围：1-3 |
| useragent | string | 否 | Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 | 用户代理字符串，用于模拟不同的浏览器 |
| ismobile | boolean | 否 | false | 是否模拟移动设备，true 为移动设备模式，false 为桌面模式 |

# **4\. 返回参数**

| **参数名** | **参数类型** | **备注** |
| --- | --- | --- |
| DataStatus.StatusCode | int | 接口返回状态码，100 为成功 |
| DataStatus.StatusDescription | string | 接口返回状态说明 |
| DataStatus.ResponseDateTime | string | 接口数据返回时间 |
| DataStatus.DataTotalCount | int | 此条件下的总数据量，一般为1 |
| Data.Image | string | 截图图片，当responseFormat为base64时返回base64编码的图片数据，为url时返回图片链接 |
| Data.Content | string | 网页文本内容，提取的网页主要文本信息 |