Glossaire Shotbot
Définitions des termes clés de l'API et des captures d'écran Shotbot, regroupées par thème. Cliquez sur un terme pour obtenir son ancre directe. Une question qui manque ? Écrivez-nous.
Captures d'écran
Instantané visuel d'une page web telle qu'elle apparaît dans un navigateur à un instant donné. Shotbot génère les captures via un navigateur headless Chromium qui exécute le JavaScript, charge toutes les ressources et attend que la page soit stable avant de la capturer.
Vignette au format WebP à 1280 px de large, générée automatiquement pour chaque capture APIv2. Elle est affichée sur la page de résultat /c/{token}/ et accessible via cache.shotbot.net/t/{token}/preview.
Capture de la hauteur totale d'une page, bien au-delà de la zone visible à l'écran (viewport). Activée via le paramètre full_page=true en APIv2. Utile pour les pages longues dont on veut conserver l'intégralité du contenu.
Capture non téléversée sur le CDN public. Le fichier est récupérable via GET /capture/{token}/file (autant de fois que voulu) puis purgé automatiquement après une courte période de conservation. Activée via le paramètre private=true ; c'est le défaut côté CLI et MCP. La déduplication est désactivée en mode privé.
Processus de chargement et d'affichage d'une page web par le navigateur headless avant que l'image ne soit générée. La durée effective de rendu, de la navigation à la capture, est mesurée en secondes et stockée dans le champ render_time_s.
Formats et dimensions
Dimensions simulées de la fenêtre du navigateur headless (largeur × hauteur en pixels). Détermine la mise en page de la page capturée. La largeur par défaut est 1280 px. Les abonnés Shotbot Pro peuvent utiliser des viewports personnalisés de 280 à 3840 px.
Largeur finale de l'image générée, indépendante du viewport. La page est d'abord rendue à la largeur du viewport, puis l'image est redimensionnée à la taille de sortie demandée. Paramètre output_size en APIv2.
Rapport largeur/hauteur appliqué pour rogner l'image après rendu. Le ratio par défaut est 16:9. Les abonnés Shotbot Pro peuvent définir une hauteur exacte via crop_height pour obtenir des formats sur mesure.
Type de fichier produit par Shotbot. Cinq formats disponibles : JPEG (compressé, idéal pour les photos et visuels), PNG (sans perte, texte et interfaces), WebP (moderne, plus léger que JPEG à qualité égale), AVIF (nouvelle génération, compression maximale), PDF (document imprimable).
Niveau de compression appliqué à l'image générée (JPEG, WebP, AVIF). Exprimé de 1 à 100 : une valeur élevée préserve les détails mais produit un fichier plus lourd. La qualité par défaut est 95 (JPEG), 92 (WebP), 85 (AVIF).
API et intégration
Identifiant secret qui authentifie vos requêtes auprès de Shotbot. À transmettre dans l'en-tête HTTP Authorization: Bearer {clé} pour l'APIv2, ou via le paramètre k={clé} pour l'APIv1. Disponible sur votre page de compte.
Identifiant unique de 32 caractères assigné à chaque capture APIv2. Permet de suivre l'état d'avancement et de récupérer l'image finale. Format base62 ([A-Za-z0-9]). Exemple d'URL résultante : static.shotbot.net/{t1}/{t2}/{token}.jpg.
État courant d'une capture APIv2. Quatre valeurs possibles : queued (en attente de traitement), processing (en cours), done (terminée avec succès), failed (échec). Interrogeable via GET /capture/{token}.
Les captures sont traitées dans des files dédiées selon leur type : comptes payants et crédits (Q2), lots (Q3), formulaire web anonyme (Q4). Les abonnés Shotbot Pro disposent d'une priorité élevée dans la file Q2.
Soumission en bloc de plusieurs URLs en une seule requête (POST /capture/batch). La limite par défaut est 500 URLs par requête, portée à 5 000 pour les abonnés Shotbot Pro. Le quota est prélevé de façon atomique pour éviter les dépassements.
URL notifiée par HTTP POST dès qu'une capture est terminée. Permet d'éviter le polling répété de l'API. Configuré via callback_url et sécurisé par callback_secret : Shotbot inclut ce secret dans la notification, que vous vérifiez côté serveur.
Si la même URL est soumise plusieurs fois pendant qu'une capture est encore en file d'attente ou en traitement, Shotbot renvoie la même capture sans créer de doublon. La déduplication est désactivée en mode capture privée et lors d'une mise à jour forcée.
Options avancées
Délai, en secondes, laissé au JavaScript de la page avant que la capture ne soit déclenchée. Utile pour les applications monopages (SPA), les animations ou les chargements asynchrones. Valeurs possibles : 0 à 5 s (0 à 30 s pour Shotbot Pro). Paramètre wait_time.
Expression CSS ciblant un élément précis de la page. La capture est automatiquement rognée aux dimensions de cet élément. Pratique pour isoler un graphique, un composant ou une section. Réservé aux abonnés Shotbot Pro. Paramètre selector.
Émulation de la préférence système prefers-color-scheme : valeurs dark ou light. Permet de capturer le mode sombre d'un site sans modifier l'URL ni injecter de CSS. Disponible pour tous les comptes. Paramètre color_scheme.
Habillage décoratif appliqué autour de l'image résultante. Variantes disponibles : ombre portée (shadow), chrome navigateur (browser_chrome, affiche la vraie URL), maquette de smartphone (mobile), de tablette (tablet), coins arrondis (rounded). Les comptes gratuits reçoivent un filigrane Shotbot sur les cadres non vides.
Localisation géographique du serveur de capture utilisé : Paris (France), Montréal (Canada), Singapour, Sydney (Australie) ou Hanoï (Vietnam). Utile pour tester l'affichage d'un site selon sa zone géographique ou contourner des restrictions régionales. Disponible pour Shotbot Pro (Paris gratuit). Paramètre render_region.
Identifiants HTTP Basic Auth transmis au navigateur headless avant le chargement de la page. Permet de capturer des sites protégés par un .htaccess ou équivalent. Les identifiants sont supprimés de la base dès la capture terminée, ou automatiquement après 2 heures. Paramètre http_auth.
Tableau de cookies transmis au navigateur headless avant la navigation vers l'URL cible. Permet de capturer des pages nécessitant une session utilisateur active. Maximum 50 cookies par requête. Réservé aux abonnés Shotbot Pro. Paramètre cookies.
Compte et abonnement
Unité de compte consommée par chaque capture générée. Un crédit correspond à une capture, quelle que soit sa taille ou son format. Les crédits sont valables sans limite de durée et rechargeables à tout moment depuis votre espace client.
Nombre maximum de captures disponibles par mois, inclus dans les plans payants. Remis à zéro automatiquement le premier de chaque mois. S'ajoute à votre solde de crédits : les crédits et le quota mensuel sont utilisés de façon complémentaire.
Abonnement mensuel débloquant les options de rendu (sélecteur CSS, injection de cookies, régions de rendu, temps d'attente étendu jusqu'à 30 s), des viewports personnalisés jusqu'à 3840 px, une file prioritaire et un quota mensuel de 5 000 captures.
Capture récurrente configurée pour s'exécuter automatiquement selon un planning défini : toutes les heures, tous les jours, toutes les semaines… Gérée depuis la section Captures planifiées de votre compte. Chaque exécution consomme un crédit ou s'impute sur votre quota mensuel.
Aucun terme ne correspond. Proposez-en un.
Un terme manque ?
Le glossaire évolue. Si un concept n'est pas défini ici, contactez-nous et on l'ajoutera.