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