Делайте скриншоты веб-сайтов с помощью нашего RESTful Screenshot API
REST API GrabzIt позволяет вам захватывать URL или HTML целиком, используя методы RESTful. Прежде чем начать, внимательно прочитайте следующие предостережения, в зависимости от вашего варианта использования, возможно, подойдет одно из наших других API-решений.
- Некоторые функции, такие как объединение и шифрование захватов, недоступны через этот REST API. Для использования этих функций вам нужно будет использовать другой Библиотека API
- Не используйте этот API на клиентской стороне, он откроет ваш ключ приложения! Вместо этого используйте JavaScript API
Для начала просто выберите то, что вы хотите сделать из фильтра ниже, и доступные параметры будут отображаться вместе с базовым примером.
Делая запросы, пожалуйста, убедитесь, все Значения параметров кодируются в URL.
При конвертации HTML все параметры должны быть размещено в теле запроса как пары ключ-значение. Убедитесь, что все значения параметров имеют URL-кодировку, а тип содержимого применение / х-WWW-форм-urlencoded.
Захват будет возвращен в HTTP-ответе. Следующие дополнительные параметры также доступны с этим типом захвата, все из которых являются необязательными, за исключением отмеченных как обязательные. При тестировании функциональности API рекомендуем использовать Почтальон упростить процесс.
URL - URL для захвата.
необходимые
HTML - HTML для конвертации.
необходимые
При конвертации HTML вы должны использовать HTTP POST.
обычай - пользовательский идентификатор, который вы можете связать с захватом.
Это будет возвращено с любым URL обратного вызова, который вы указали.
формат - формат записи должен быть.
По умолчанию: jpg
Опции:
bmp8
bmp16
bmp24
BMP
CSV
GIF
HTML
JPG
JSON
PDF
DOCX
PNG
поисковая оптимизация
размолвка
WebP
XLSX
address - URL для выполнения HTML-кода. Может быть полезен, если преобразуемый HTML использует относительные URL-адреса к таким ресурсам, как CSS и изображения.
По умолчанию: пусто
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 - URL веб-страницы, которая должна использоваться в качестве обложки для PDF
По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если ширина вывода указана, высота вывода будет пропорциональна ширине вывода
Максимум: максимальная высота упаковки
Полная высота: -1 (пропуск -1 означает, что высота эскиза не уменьшается)
высота - высота получаемого анимированного GIF в пикселях.
По умолчанию: 120px
Максимум: максимальная высота упаковки
Авто-размер: -1 (передача -1 означает, что высота анимированный GIF масштабируется по отношению к его ширине, если высота автоматически измеряется, ширина не может)
hide - CSS селекторы один или несколько элементов HTML на веб-странице, которые нужно скрыть, чтобы указать несколько элементов HTML для скрытия, разделяя каждый селектор запятой.
По умолчанию: пусто
includealltables - если true, вся таблица на веб-странице будет извлечена, и каждая таблица появится на отдельном листе электронной таблицы.
Доступно только с форматом XLSX
По умолчанию: 0
Опции:
0 = указывает, что все таблицы не будут извлечены
1 = указывает, что все таблицы будут извлечены
includeheadernames - если в таблицу будут включены истинные имена заголовков
По умолчанию: 1
Опции:
0 = указывает, что имена заголовков не будут включены в таблицу
1 = указывает, что имена заголовков будут включены в таблицу
includeimages - если истина, изображения веб-страницы должны быть включены в DOCX
По умолчанию: 1
Опции:
0 = указывает, что документ DOCX не будет включать изображения веб-страниц
1 = указывает, что документ DOCX будет включать изображения веб-страниц
includelinks - true, если ссылки должны быть включены в документ
По умолчанию: 1
Опции:
0 = указывает, что документ не должен содержать ссылки
1 = указывает, что документ должен содержать ссылки
includeoutline - правда, если PDF закладки должны быть включены
По умолчанию: 0
Опции:
0 = указывает, что документ PDF не будет содержать схему
1 = указывает, что документ PDF будет содержать схему
2 = указывает, что должно быть возвращено представление веб-сайта с помощью поисковой системы.
скорость - скорость анимированного GIF.
По умолчанию: 1
Минимум: 0.2
Максимум: 10
Начало - начальная позиция видео, которое должно быть преобразовано intанимированный GIF.
По умолчанию: секунды 0
tabletoinclude - индекс таблицы, которую нужно преобразовать, если все таблицы на веб-странице упорядочены сверху вниз по веб-странице
По умолчанию: 1
target - этот параметр указывает CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут intДокумент, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый.
По умолчанию: пусто
target - этот параметр указывает CSS селектор единственного HTML-элемента на целевой веб-странице, который должен быть повернут intoa, все остальные части веб-страницы игнорируются. Если есть несколько совпадающих элементов HTML, выбирается первый.
По умолчанию: пусто
target - идентификатор единственного HTML-элемента на веб-странице, который должен использоваться для извлечения таблиц из
templateid - добавить шаблон Идентификатор, который определяет верхний и нижний колонтитулы документа
По умолчанию: пусто
title - укажите название документа PDF
По умолчанию: пусто
waitfor - определяет элемент HTML, используя CSS селектор, Когда элемент видимый захват выполнен, Если есть несколько совпадающих элементов HTML, выбирается первый. Когда этот параметр используется, он будет ждать максимум 25 секунд, прежде чем будет выполнен захват.
width - ширина получаемого эскиза в пикселях
По умолчанию: если и ширина вывода, и высота вывода не указаны или 0, тогда ширина и высота вывода будут соответствовать ширине и высоте окончательного изображения, если высота вывода указана, ширина вывода будет пропорциональна высоте вывода.
Максимум: максимальная ширина для упаковки
Полная ширина: -1 (пропуск -1 означает, что ширина эскиза не уменьшается)
ширина - ширина получаемого анимированного GIF в пикселях.
По умолчанию: 180px
Максимум: максимальная ширина для упаковки
Авто-размер: -1 (передача -1 означает, что ширина анимированный GIF масштабируется по отношению к его высоте, если ширина автоматически измеряется, высота не может)
Обработка ошибок
Если есть какая-то проблема с запросом, который вы сделали к API, будет возвращен объект JSON с объяснением ошибки. Лучший способ определить это — проверить тип содержимого ответа перед обработкой, если его application/json произошла ошибка. Код ошибки, найденный в JSON, следует за стандартный список кодов.
{
"Result": false,
"Code":"URL is missing",
"Message":100
}