Shotbot



Documentation de l'API Hébergé (APIv1)

Fonctions

add - créer une capture d'écran
show - afficher une capture d'écran
update - actualiser une capture d'écran
status - état du compte

Toutes les fonctions de l'API Screenshot renvoient un code retour standard.

Créer une capture (add)

Appellez l'adresse suivante:

https://add.shotbot.net/k=clé/url

Le paramètre clé correspond à la clé webmaster qui vous a été fournie lors de votre inscription. Elle se présente sous la forme d'une variable de 12 caractères alphanumériques et est indispensable à l'utilisation de l'API de capture d'écran. Exemple: aee91bcc25a8.

Le paramètre url correspond à l'adresse URL de la page dont vous souhaitez générer une capture d'écran. Il est nécessaire d'inclure le préfixe « http:// ».

Pour désactiver temporairement la prise en charge JavaScript, ajoutez /nojs/ à l'adresse d'appel. Exemple: https://add.shotbot.net/k=clé/nojs/url.

Pour modifier le timeout de chargement du site à capturer, utilisez la variable s=. Exemple: https://add.shotbot.net/k=clé/nojs/t=5/url.


Afficher une capture (show)

Appellez une des adresses suivantes:

https://static.shotbot.net/md5url/format.jpg
https://cache.shotbot.net/s=format/url

Le paramètre url doit être strictement identique a celui utilisé lors de l'appel de la fonction add.

Le paramètre format permet de choisir une taille d'image prédéfinie. Les formats disponibles sont: 80 (80x60), 92 (92x69), 120 (ascreen 120x90), 160 (160x120), 240 (240x180), 320 (320x240), et 1024 (1024x768). La valeur par défaut de ce paramètre est 120x90 (ascreen)

Le paramètre clé-webmaster n'est pas requis pour l'affichage d'un screenshot.

Actualiser une capture (update)

Appellez l'adresse suivante :

https://update.shotbot.net/k=clé/url

Les paramètres utilisés pour actualiser une capture d'écran web sont identiques à ceux utilisés pour la fonction add.

Etat du compte Webmaster (status)

Pour obtenir le nombre de captures disponibles par clé, appellez l'adresse suivante :

https://status.shotbot.net/k=clé

Le serveur renverra une réponse de type "OK a:b:c", où a est le nombre d'opérations autorisées par mois, b le nombre d'opérations déjà effectuées sur cette période, et c le nombre d'opérations disponibles dans votre réserve (allopass).

En cas d'erreur (clé invalide ou API screenshot temporairement indisponible), le serveur renverra un code d'erreur standard.