API简介
生成指定URL的网页截图或缩略图。
旧版本请参考:网页截图
V2版本新增全屏截图、带壳截图等功能,并修复了一些已知问题。
全屏截图:
支持全屏截图,通过设置fullscreen=true
来支持全屏截图。全屏模式下,系统将自动获取网页最大高度后截图,此时height
参数将无效(width
不受影响)。
带壳截图:
我们内置了5中设备外壳模板供您选择,以便将截图嵌入到设备模型中,获得更好的视觉效果。当使用带壳截图时,不支持设置宽度和高度。
API信息
接口地址:https://oneapi.coderbox.cn/openapi/api/webpage/screenshot/v2
请求方式:POST
调用类型:同步
认证方式:AccessToken认证
频率限制:不限制
请求参数
BODY参数
参数名 | 类型 | 必填 | 含义 | 说明 |
---|---|---|---|---|
url | string | 是 | 要截图的网页链接 | 例如:https://baidu.com |
width | number | 否 | 截图宽度 | 默认为:1920 |
height | number | 否 | 截图高度 | 默认为:1080 |
waitSeconds | number | 否 | 等待网页加载的秒数 | 对于某些异步加载或者加载缓慢的网页,可等待网页全部加载完成后再进行截图。单位:秒,取值范围:[0,3] |
device | string | 否 | 截图设备类型 | 可选值:mobile , pc 。当device=mobile 时,您传入的width 和height 参数将被放大3倍,以此来提高移动设备下截图的清晰度,如果您需要精确的宽度和高度像素值,请计算后传入 |
fullscreen | bool | 否 | 是否全屏截图 | ture:全屏截图,false:非全屏截图 |
withShell | string | 否 | 带壳截图的设备模板 | 取值:iPhone 14 Pro ,iPhone X ,iPhone 8 Plus ,iPad ,MacBook Pro 。注意:当使用带壳截图时,不支持设置宽度和高度,系统将自动匹配适合模板的截图大小。 |
响应参数
参数名 | 类型 | 必填 | 含义 | 说明 |
---|---|---|---|---|
data | string | 是 | 截图图片地址 | - |
响应示例
{"code": 0,"data": "https://file.coderbox.cn/oneapi/task/20240103/dcb654334d6e4e8981d22935652e7349.png","msg": "","timestamp": 1704293368531
}
OneAPI简介:OneAPI是一个简单、轻量的开放接口平台,提供常用场景的接口、以及图像识别等API服务,目前正在开发中,欢迎感兴趣的小伙伴一起参与开发。
更多API服务请查看:https://oneapi.coderbox.cn