# Paramètres

# jeton

  • Requis
  • Type string

Ce paramètre est obligatoire pour tous les appels

Il s'agit de votre jeton d'authentification. Toutes vos demandes doivent être autorisées avec votre jeton privé.

Jeton privé

_USER_TOKEN_

# url

  • Requis
  • Type string

Vous aurez besoin d'une URL pour prendre une capture d'écran de sa page Web. Assurez-vous qu'elle commence par http ou https et qu'elle est entièrement codé.

Par exemple, dans l’URL suivante : https://www.apple.com/us/search/iphonex?src=globalnav l'URL doit être codée lors de l'appel de l'API de captures d'écran comme suit : 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"

# dispositif

  • Optionnel
  • Type string

En option, si vous ne souhaitez pas spécifier d'agent utilisateur mais que vous souhaitez recevoir les requêtes d'un périphérique spécifique, vous pouvez utiliser ce paramètre. Deux options sont disponibles : desktop et 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

  • Optionnel
  • Type string

Si vous souhaitez faire la demande avec un agent utilisateur personnalisé, vous pouvez la transmettre ici et nos serveurs la transmettront à l'URL demandée.

  • 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

  • Optionnel
  • Type string

Passer en option css_click_selector paramètre permettant de cliquer sur un élément de la page avant que le navigateur ne capture la page HTML résultante.

Il doit s'agir d'un sélecteur CSS complet et valide, par exemple #some-button or .some-other-button et correctement codé.

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

# volute

  • Optionnel
  • Type boolean

Passer en option &scroll=true paramètre pour faire défiler la page entière avant de capturer la capture d'écran. Ce sera le défilement par défaut pour une &scroll_interval de 10 secondes.

Si vous souhaitez faire défiler plus de 10 secondes, veuillez envoyer le &scroll=true&scroll_interval=20.

VOTRE &scroll_interval est d'un minimum de 10 secondes et d'un maximum de 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"

# Boutique

  • Optionnel
  • Type boolean

Passer en option &store=true paramètre pour stocker une copie de la capture d'écran dans le Stockage en nuage crawlbase (ouvre une nouvelle fenêtre) (opens new window).

Crawlbase vous renverra le screenshot_url de la capture d'écran stockée dans les en-têtes de réponse.

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

# mode

  • Optionnel
  • Type String

Passer en option &mode=viewport paramètre, la valeur par défaut est fullpage pour prendre une capture d'écran de la fenêtre d'affichage. La largeur par défaut est la largeur de l'écran et la hauteur est de 800 pixels maximum.

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

# largeur

  • Optionnel
  • Type Integer

Passer en option &width=1200 dans le paramètre pixel pour redimensionner la capture d'écran à cette largeur maximale. La largeur par défaut est la largeur de l'écran, ne prend effet que si elle est combinée avec 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"

# la taille

  • Optionnel
  • Type Integer

Passer en option &height=1800 dans le paramètre pixel pour redimensionner la capture d'écran à cette hauteur maximale. La hauteur par défaut est la hauteur de l'écran, ne prend effet que si elle est combinée avec 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"