使用我們的RESTful屏幕截圖API獲取網站屏幕截圖

GrabzIt的REST API允許您使用RESTful技術完全捕獲URL或HTML。 在開始之前，請根據您的用例仔細閱讀以下注意事項，我們的其他API解決方案之一可能更合適。

要開始使用，只需從下面的過濾器中選擇要執行的操作，然後將顯示可用的參數以及一個基本示例。

    https://api.grabz.it/services/convert?key=Sign in to view your Application Key&format=&url=https%3A%2F%2Fspacex.com%2F

    curl 
    -d key=Sign in to view your Application Key 
    -d format= 
    -d html=%3Ch1%3EConvert%20Me%21%3C%2Fh1%3E 
    https://api.grabz.it/services/convert    

然後，捕獲結果將在HTTP響應中返回。 此類捕獲還可以使用以下附加選項，所有這些選項都是可選的，除了那些標記為必需的選項之外。 在測試API功能時，我們建議使用 郵差 簡化流程。

• 網址 -捕獲的URL。
  • 需要的
• HTML -轉換的HTML。
  • 需要的
  • 轉換HTML時，必須使用HTTP POST。
• 關鍵 - 你的 應用密鑰.
  • 需要的
• 回電話 -處理程序GrabzIt的URL在完成工作後應調用。
  • 通過遵循每種語言的文檔來了解如何創建處理程序 ASP.NET, Java的, Node.js的, Perl的, PHP, 蟒蛇 及 紅寶石.
• 習俗 -您可以與捕獲關聯的自定義標識符。
  • 這將與您指定的任何回調URL一起返回。
• 格式 -捕獲應採用的格式。
  • 默認值：jpg
  • 選項：
    • bmp8
    • bmp16
    • bmp24
    • bmp
    • CSV
    • GIF
    • HTML
    • jpg文件
    • JSON
    • PDF格式
    • DOCX
    • PNG
    • SEO
    • 鬥嘴
    • mp4
    • 網頁
    • XLSX
• address -用於執行HTML代碼的URL。如果要轉換的HTML使用相對於CSS和圖像等資源的相對URL，則很有用。
  • 默認值：空
• background -如果為true，則網頁背景應包含在PDF中
  • 默認值：1
  • 選項：
    • 0 =表示PDF文檔不應包含網頁背景
    • 1 =表示PDF文檔應包含網頁背景
• background -如果為true，則網頁的背景圖片應包含在DOCX中
  • 默認值：1
  • 選項：
    • 0 =表示DOCX文檔不應包含網頁背景圖片
    • 1 =表示DOCX文檔應包含網頁背景圖像
• bwidth -瀏覽器的寬度（以像素為單位）
  • 警告此功能目前處於測試階段，可能無法提供一致的結果。
  • 默認值：1366
  • 上限：10000
  • 自動寬度：-1 （傳遞-1表示 瀏覽器的寬度 匹配文檔的寬度）
• bheight -瀏覽器的高度（以像素為單位）。
  • 默認值：1170
  • 上限：10000
  • 全長：-1 （傳遞-1表示獲取整個網頁的截圖）
• click -使用來指定HTML元素 CSS選擇器 點擊。 請記住，查看點擊效果可能也需要延遲
  • 警告此功能目前處於測試階段，可能無法提供一致的結果。
• country - 這個國家 屏幕截圖/捕獲應取自。
  • 默認值：當前最快的位置
  • 選項：“ SG”，“ UK”，“ US”
• coverurl -應該用作PDF封面的網頁的網址
  • 默認值：空
• customwatermarkid -添加一個 習俗 watermark 到文件
  • 默認值：空
• delay -的毫秒數 等待截圖之前
  • 默認值：0
  • 上限：30000
• 為期 -應該轉換的視頻的長度（以秒為單位） int動畫GIF。
  • 默認值：包裝的最大長度
• 為期 - the length in seconds of the web page should be recorded for.
  • 默認值：包裝的最大長度
• export - “ 導出網址 指定捕獲也應導出到的位置。
• FPS - the number of frames per second that should be captured.
  • 默認值：10
  • 最低：0.2
  • 上限：60
• hd -如果圖像真實 捕獲將是高清 這會使圖像尺寸增加一倍。
  • 默認值：0
  • 選項：
    • 0 =創建高清圖像
    • 1 =創建高清圖像
• height -結果縮略圖的高度（以像素為單位）
  • 默認值：如果未同時指定輸出寬度和輸出​​高度或為0，則輸出寬度和高度將與最終圖像的寬度和高度相匹配；如果指定了輸出寬度，則輸出高度將與輸出寬度成比例
  • 最大：包裝的最大高度
  • 全高：-1 （傳遞-1表示縮略圖的高度不會減小）
• height - “ 自定義文件高度 單位為毫米
  • 默認： 頁面大小 建議身高
  • 最低：15
• 建議身高 -生成的動畫GIF的高度（以像素為單位）。
  • 默認值：120px
  • 最大：包裝的最大高度
  • 自動調整大小：-1 （傳遞-1表示 動畫GIF縮放 關於寬度，如果要自動調整高度，則寬度不能）
• hide - “ CSS選擇器 網頁中要隱藏的一個或多個HTML元素中的一個，以指定多個HTML元素來隱藏，以逗號分隔每個選擇器。
  • 默認值：空
• includealltables -如果為true，則將提取網頁上的所有表格，並且每個表格都顯示在單獨的電子表格中。
  • 僅適用於XLSX格式
  • 默認值：0
  • 選項：
    • 0 =表示將不提取所有表
    • 1 =表示將提取所有表
• includeheadernames -如果表中包含真實的標題名稱
  • 默認值：1
  • 選項：
    • 0 =表示標題名稱將不包含在表中
    • 1 =表示標題名稱將包含在表中
• includeimages -如果為true，則網頁圖像應包含在DOCX中
  • 默認值：1
  • 選項：
    • 0 =表示DOCX文檔將不包含網頁圖像
    • 1 =表示DOCX文檔將包含網頁圖像
• includelinks -如果鏈接應包含在文檔中，則為true
  • 默認值：1
  • 選項：
    • 0 =表示文檔不應包含鏈接
    • 1 =表示文檔應包含鏈接
• includeoutline -如果為真 PDF書籤 應該包括在內
  • 默認值：0
  • 選項：
    • 0 =表示PDF文檔將不包含大綱
    • 1 =表示PDF文檔將包含大綱
• mergeid -添加捕獲的ID 合併在新文檔的開頭
  • 默認值：空
• mtop -應在文檔頁面頂部顯示的以毫米為單位的邊距
  • 默認值：10
• mleft -應在文檔頁面左側顯示的以毫米為單位的邊距
  • 默認值：10
• mbottom -應在文檔頁面底部顯示的以毫米為單位的邊距
  • 默認值：10
• mright -PDF文檔右側應出現的以毫米為單位的邊距
  • 默認值：10
• media - “ PDF文檔的CSS媒體類型
  • 默認值：Print
  • 選項：
    • 列印
    • 屏幕
• noads - 如果屬實 廣告應自動隱藏.
  • 默認值：0
  • 選項：
    • 0 =展示廣告
    • 1 =隱藏廣告
• nonotify -如果為true，則通常會找到所有 Cookie通知應自動隱藏.
  • 默認值：0
  • 選項：
    • 0 =顯示Cookie通知
    • 1 =隱藏Cookie通知
• orientation -文件的方向
  • 默認值：縱向
  • 選項：
    • 肖像
    • 風景
• pagesize -文檔的頁面大小
  • 默認值：A4
  • 選項：
    • A3
    • A4
    • A5
    • A6
    • B3
    • B4
    • B5
    • B6
    • 法律
    • 信
• password - “ 密碼保護文件 同
  • 默認值：空
• proxy - HTTP代理詳細信息 瀏覽器軟件應使用它來創建此捕獲
• post -您要發送的任何發布參數。
• quality - “ 捕獲質量，JPG和WEBP的默認壓縮率為90％，GIF為85％。 此參數對BMP，PNG或TIFF圖像無效。
  • 降低質量會減少文件大小並減少下載時間。
  • 默認值：-1
  • 最低：-1
  • 上限：100
• 重複 -循環播放動畫GIF的次數。
  • 默認值：0
  • 連續循環：0
  • 從不循環：-1
• 反轉 -如果為true，則動畫GIF的幀反轉
  • 默認值：0
  • 選項：
    • 0 =表示將不顯示動畫
    • 1 =表示動畫將被反轉
• requestas -您希望使用的用戶代理類型
  • 默認值：0
  • 選項：
    • 0 =表示應返回網站的標準版本
    • 1 =表示 手機版 網站的應退還
    • 2 =表示應返回網站的搜索引擎視圖
• 速度 -動畫GIF的速度。
  • 默認值：1
  • 最低：0.2
  • 上限：10
• 開始 -應該轉換的視頻的起始位置 int動畫GIF。
  • 默認值：0秒
• tabletoinclude -要轉換的表的索引，即網頁中的所有表從網頁頂部到底部的順序
  • 默認值：1
• target -此參數指定 CSS選擇器 目標網頁上唯一要翻轉的HTML元素 int在文檔中，將忽略網頁的所有其他部分。 如果有多個匹配的HTML元素，則選擇第一個。
  • 默認值：空
• target -此參數指定 CSS選擇器 目標網頁上唯一要翻轉的HTML元素 int在圖像中，將忽略網頁的所有其他部分。 如果有多個匹配的HTML元素，則選擇第一個。
  • 默認值：空
• target -網頁中唯一可用於從中提取表格的HTML元素的ID
  • 默認值：空
• transparent -如果為true 圖像捕獲應該是透明的。 這僅與png和tiff圖像兼容。
  • 默認值：0
  • 選項：
    • 0 =創建非透明圖像
    • 1 =創建透明圖像
• templateid -添加一個 模板 指定文檔的頁眉和頁腳的ID
  • 默認值：空
• title -提供PDF文檔的標題
  • 默認值：空
• waitfor -使用來指定HTML元素 CSS選擇器。 一旦元素是 可見捕獲已執行。 如果有多個匹配的HTML元素，則選擇第一個。 使用此參數時，將最多等待25秒才能執行捕獲。
• width -結果縮略圖的寬度（以像素為單位）
  • 默認值：如果未同時指定輸出寬度和輸出​​高度或為0，則輸出寬度和高度將與最終圖像的寬度和高度相匹配；如果指定了輸出高度，則輸出寬度將與輸出高度成比例
  • 最大：包裝的最大寬度
  • 全寬：-1 （傳遞-1表示縮略圖的寬度不會減小）
• width - “ 自定義文檔寬度 單位為毫米
  • 默認： 頁面大小 寬度
  • 最低：15
• 寬度 -生成的動畫GIF的寬度（以像素為單位）。
  • 默認值：180px
  • 最大：包裝的最大寬度
  • 自動調整大小：-1 （傳遞-1表示 動畫GIF縮放 關於其高度，如果寬度是自動調整大小，則高度不能）

錯誤處理

如果您向 API 發出的請求存在問題，將返回一個 JSON 對象來解釋錯誤。 確定這一點的最佳方法是在處理之前檢查響應的內容類型，如果 application/json 發生了錯誤。 在 JSON 中找到的錯誤代碼如下 標準代碼列表.

{
    "Result": false,
    "Code":"URL is missing",
    "Message":100
}