Faire des demandes | Documentation | Screenshot API | WhoisXML API

Formuler des demandes

API endpoint

GET https://website-screenshot.whoisxmlapi.com/api/v1?apiKey=YOUR_API_KEY&url=google.com&credits=DRS
L'activation de votre compte après l'enregistrement prend jusqu'à une minute.

Collection de Postman

Postman est une application web et de bureau qui vous permet de faire des demandes à une API à partir d'une interface utilisateur graphique. Nous recommandons d'utiliser Postman avec les points d'extrémité des API WhoisXML pour explorer les fonctionnalités des API, ainsi que pour résoudre les problèmes liés à votre application.

La collection Postman de l'API WhoisXML est disponible aux liens suivants :

La collection comprend un environnement préconfiguré. Vous devrez configurer la clé_api pour déclencher chaque requête. Obtenez votre CLÉ d'API personnelle sur la page Mes produits. Si vous avez des questions relatives à l'API, contactez-nous.

Paramètres d'entrée

apiKey

Nécessaire. Obtenez votre clé API personnelle sur la page Mes produits.

url

Obligatoire. L'url du site web cible.

Il est également possible de spécifier des numéros de port, par exemple example.com:80.

Notez que si l'URL contient des "caractères spéciaux", par exemple '&, ?, #, =', vous devez encoder l'URL.

credits

En option.

SA - Les crédits Screenshot API seront pris en compte lorsque l'API sera appelée.

DRS — Les crédits de la Domain Research Suite seront pris en compte lors de l'appel de l'API.

Valeurs acceptables : SA | DRS

Défaut : SA

imageOutputFormat

Facultatif. Format de sortie de la réponse.

Valeurs acceptables : image | base64

Valeur par défaut : image

errorsOutputFormat

Facultatif. Format de sortie des erreurs.

Valeurs acceptables : JSON | XML

Par défaut : JSON

type

En option. Type de sortie d'image.

Valeurs acceptables : jpg | png | pdf

Valeur par défaut : jpg

quality

En option. Qualité de l'image. (uniquement pour le type jpg ).

Valeurs acceptables : 40 < quality< 99

Valeur par défaut : jpg

width

Facultatif. Largeur de l'image (px).

Valeurs acceptables : 100 < width< 3000

Valeur par défaut : 800

height

Facultatif. Hauteur de l'image (px).

Valeurs acceptables : 100 < width< 3000

Valeur par défaut : 600

thumbWidth

Facultatif. thumb width de l'image (px).

Valeurs acceptables : 50 < thumbWidth < width param value

Valeur par défaut : 0

mode

En option.

rapide - attente de l'événement document.load.

lent - attente d'un événement d'inactivité du réseau.

Valeurs acceptables : rapide | lent

Valeur par défaut : fast

scroll

Facultatif. Si elle est spécifiée (n'importe quelle valeur), elle fait défile vers le bas et jusqu'à la scrollPosition (utile pour les captures d'écran en pleine page).

scrollPosition

Facultatif. Spécifie le comportement du scroll

Valeurs acceptables : haut | bas

Valeur par défaut : top

fullPage

Facultatif. Si spécifié (n'importe quelle valeur), fait une capture d'écran pleine page.

noJs

Facultatif. Si elle est spécifiée (n'importe quelle valeur), elle désactive JS.

delay

Facultatif. Délai personnalisé (ms) avant la capture d'écran.

Valeurs acceptables : 0 < delay< 10000 ms

Valeur par défaut : 250

timeout

Facultatif. Délai personnalisé (ms) pour le chargement de la page. L'API répondra par une erreur si notre serveur ne peut pas charger la page dans le délai spécifié.

Valeurs acceptables : 1000 < timeout < 30000 ms

Valeur par défaut : 15000

scale

Facultatif. valeur deviceScaleFactor pour l'émulateur.

Valeurs acceptables : 0,5 < scale< 4,0

Valeur par défaut : 1,0

retina

Facultatif. Si spécifié (n'importe quelle valeur), émule l'affichage rétina.

ua

Facultatif. La chaîne d'en-tête "User-Agent".

cookies

Facultatif. La chaîne d'en-tête "Cookie" au format suivant : name1=value1;name2=value2

Veuillez vous assurer que la chaîne de requête est correctement encodée.

mobile

Facultatif. Si spécifié (n'importe quelle valeur), émule l'appareil mobile.

touchScreen

Facultatif. Si spécifié (n'importe quelle valeur), émule l'appareil avec un écran tactile.

landscape

Facultatif. Si elle est spécifiée (n'importe quelle valeur), la page est rendue en mode paysage (utile pour l'émulation des smartphones).

failOnHostnameChange

Facultatif. Si elle est spécifiée (n'importe quelle valeur), l'API répond par le code d'erreur HTTP 422 lorsque le nom de domaine cible est modifié en raison de redirections.

Accès gratuit

Après l'inscription, vous bénéficiez automatiquement d'un plan d'abonnement gratuit limité à 500 crédits DRS.

Limitation de l'utilisation et des demandes

Le nombre maximum de demandes par minute est de 120. Si la limite est dépassée, vos demandes suivantes seront rejetées jusqu'à la minute suivante.

Cette API est également disponible avec un équilibreur de charge dédié et un point d'extrémité premium pour permettre des requêtes plus rapides dans le cadre de nos Premium API Services et Enterprise API Packages.