# параметры

# знак

  • необходимые
  • Тип string

Этот параметр обязателен для всех вызовов.

Это ваш токен аутентификации. Все ваши запросы должны быть авторизованы вашим личным токеном.

Частный токен

_USER_TOKEN_

# URL

  • необходимые
  • Тип string

Вам понадобится URL, чтобы сделать снимок экрана для его веб-страницы. Убедитесь, что он начинается с http или https и он полностью закодирован.

Например, в следующем URL-адресе: https://www.apple.com/us/search/iphonex?src=globalnav URL-адрес должен быть закодирован при вызове API скриншотов следующим образом: https%3A%2F%2Fwww.apple.com%2Fus%2Fsearch%2Fiphonex%3Fsrc%3Dglobalnav

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&url=https%3A%2F%2Fapple.com%2F"

# устройство

  • По желанию
  • Тип string

При желании, если вы не хотите указывать user_agent, но хотите получать запросы с определенного устройства, вы можете использовать этот параметр. Доступны два варианта: desktop и mobile.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&device=mobile&url=https%3A%2F%2Fapple.com%2F"

# user_agent

  • По желанию
  • Тип string

Если вы хотите сделать запрос с помощью пользовательского агента, вы можете передать его здесь, и наши серверы перенаправят его на запрошенный URL.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&user_agent=Mozilla%2F5.0+%28Macintosh%3B+Intel+Mac+OS+X+10_12_5%29+AppleWebKit%2F603.2.4+%28KHTML%2C+like+Gecko%29+Version%2F10.1.1+Safari%2F603.2.4&url=https%3A%2F%2Fapple.com%2F"

# css_click_selector

  • По желанию
  • Тип string

По желанию пройти css_click_selector параметр для щелчка по элементу на странице, прежде чем браузер захватит полученную HTML-страницу.

Это должен быть полный и действительный селектор CSS, например #some-button or .some-other-button и правильно закодированы.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&css_click_selector=%23some-nice-button&url=https%3A%2F%2Fapple.com%2F"

# пролистать

  • По желанию
  • Тип boolean

По желанию пройти &scroll=true параметр для прокрутки всей страницы перед тем, как сделать снимок экрана. Это будет прокрутка по умолчанию для &scroll_interval из 10 секунд.

Если вы хотите прокрутить больше 10 секунд, отправьте &scroll=true&scroll_interval=20.

Команда &scroll_interval составляет минимум 10 секунд и максимум 60.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&scroll=true&url=https%3A%2F%2Fapple.com%2F"

# магазин

  • По желанию
  • Тип boolean

По желанию пройти &store=true параметр для сохранения копии снимка экрана в Crawlbase Облачное хранилище (открывается новое окно) (opens new window).

Crawlbase отправлю вам обратно screenshot_url сохраненного снимка экрана в заголовках ответа.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&store=true&url=https%3A%2F%2Fapple.com%2F"

# Режим

  • По желанию
  • Тип String

По желанию пройти &mode=viewport параметр, по умолчанию fullpage чтобы сделать снимок экрана области просмотра. Ширина по умолчанию равна ширине экрана, а высота — максимум 800 пикселей.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&mode=viewport&url=https%3A%2F%2Fapple.com%2F"

# ширина

  • По желанию
  • Тип Integer

По желанию пройти &width=1200 в параметре пикселя, чтобы изменить размер снимка экрана на максимальную ширину. Ширина по умолчанию — это ширина экрана, действует только в сочетании с mode=viewport.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&width=1200&url=https%3A%2F%2Fapple.com%2F"

# высота

  • По желанию
  • Тип Integer

По желанию пройти &height=1800 в параметре пикселя, чтобы изменить размер снимка экрана на этой максимальной высоте. Высота по умолчанию — это высота экрана, действует только в сочетании с mode=viewport.

  • curl
  • ruby
  • node
  • php
  • python
  • go
curl "https://api.crawlbase.com/screenshots?token=_USER_TOKEN_&height=1800&url=https%3A%2F%2Fapple.com%2F"