# 参数

# 象征

  • 其他要求
  • 类型 string

所有调用都需要此参数

这是您的身份验证令牌。 您的所有请求都必须使用您的私人令牌进行授权。

私人代币

_USER_TOKEN_

# 网址

  • 其他要求
  • 类型 string

您将需要一个 url 为其网页截屏。 确保它以 http 或 https 开头,并且是 完全编码.

例如,在以下网址中: https://www.apple.com/us/search/iphonex?src=globalnav 在调用 screenshots API 时,应该对 url 进行编码,如下所示: 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 但您希望获得来自特定设备的请求,则可以使用此参数。 有两种选择: desktopmobile.

  • 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"