Prenez des captures d'écran de site Web avec notre API de capture d'écran RESTful
L'API REST de GrabzIt vous permet de capturer des URL ou du HTML entièrement en utilisant des techniques RESTful. Avant de commencer, veuillez lire attentivement les mises en garde suivantes en fonction de votre cas d'utilisation, l'une de nos autres solutions API peut-être plus appropriée.
- Certaines fonctionnalités telles que la fusion et le chiffrement des captures ne sont pas disponibles via cette API REST. Pour utiliser ces fonctionnalités, vous devrez utiliser un autre Bibliothèque d'API
- N'utilisez pas cette API côté client, elle exposera votre clé d'application! Utilisez plutôt le API JavaScript
Pour commencer, sélectionnez simplement ce que vous voulez faire dans le filtre ci-dessous et les paramètres disponibles seront affichés avec un exemple de base.
Lorsque vous faites des demandes, veuillez vous assurer tous les valeurs des paramètres sont encodées en URL.
Lors de la conversion HTML, tous les paramètres doivent être publié dans le corps de la demande sous forme de paires clé-valeur. Assurez-vous que toutes les valeurs de paramètre sont codées en URL et que le type de contenu est application / x-www-form-urlencoded.
La capture sera ensuite renvoyée dans la réponse HTTP. Les options supplémentaires suivantes sont également disponibles avec ce type de capture, qui sont toutes facultatives à l'exception de celles marquées comme requises. Lors du test de la fonctionnalité de l'API, nous vous recommandons d'utiliser Facteur pour simplifier le processus.
url - l'URL de la capture.
Requis
html - le HTML au converti.
Requis
Lors de la conversion HTML, vous devez utiliser un HTTP POST.
id personnalisé - l'identifiant personnalisé que vous pouvez associer à la capture.
Cela sera renvoyé avec toute URL de rappel que vous avez spécifiée.
le format - le format dans lequel la capture doit être.
Par défaut: jpg
options:
bmp8
bmp16
bmp24
bmp
csv
gif
html
jpg
json
pdf
docx
png
seo
querelle
webp
XLSX
address - l'URL dans laquelle exécuter le code HTML. Peut être utile si le HTML converti utilise des URL relatives vers des ressources telles que CSS et des images.
Par défaut: vide
background - si vrai, l'arrière-plan de la page Web devrait être inclus dans le PDF
Par défaut: 1
options:
0 = indique que le document PDF ne doit pas inclure l'arrière-plan de la page Web
1 = indique que le document PDF doit inclure l'arrière-plan de la page Web.
background - si vrai, les images d'arrière-plan de la page Web doivent être incluses dans le fichier DOCX
Par défaut: 1
options:
0 = indique que le document DOCX ne doit pas inclure les images d'arrière-plan de la page Web
1 = indique que le document DOCX doit inclure les images d'arrière-plan de la page Web.
bwidth - la largeur du navigateur en pixels
Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
Par défaut: 1366
Maximum: 10000
Largeur automatique: -1 (passant -1 signifie que le largeur du navigateur correspond à la largeur du document)
bheight - la hauteur du navigateur en pixels.
Par défaut: 1170
Maximum: 10000
Longueur totale: -1 (passant -1 signifie qu’un cliché de la totalité de la page Web est pris)
click - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS cliquer. N'oubliez pas qu'un délai peut également être nécessaire pour visualiser les effets du clic
Attention, cette fonctionnalité est actuellement en version bêta et peut ne pas fournir des résultats cohérents.
country - le pays la capture d'écran / capture doit être prise à partir.
Par défaut: l'emplacement le plus rapide actuel
Options: "SG", "UK", "US"
coverurl - l'URL d'une page Web qui devrait être utilisée comme page de couverture pour le PDF
height - la hauteur de la vignette obtenue en pixels
Par défaut: si la largeur de sortie et la hauteur de sortie ne sont pas spécifiées ou 0, la largeur et la hauteur de sortie correspondront à la largeur et à la hauteur de l'image finale, si la largeur de sortie est spécifiée, la hauteur de sortie sera proportionnelle à la largeur de sortie
Maximum: hauteur maximale pour le colis
Hauteur totale: -1 (passage -1 signifie que la hauteur de la vignette n'est pas réduite)
la taille - la hauteur du GIF animé obtenu en pixels.
Par défaut: 120px
Maximum: hauteur maximale pour le colis
Taille automatique: -1 (passage -1 signifie que la hauteur de la le GIF animé est mis à l'échelle par rapport à sa largeur, si la hauteur est automatiquement dimensionnée, la largeur ne peut pas)
hide - la Sélecteurs CSS parmi un ou plusieurs éléments HTML de la page Web à masquer, pour spécifier plusieurs éléments HTML à masquer, séparez chaque sélecteur par une virgule.
Par défaut: vide
includealltables - Si vrai, tous les tableaux de la page Web seront extraits, chaque tableau apparaissant dans une feuille de calcul distincte.
Disponible uniquement avec le format XLSX
Par défaut: 0
options:
0 = indique que toutes les tables ne seront pas extraites
1 = indique que toutes les tables seront extraites
includeheadernames - si de vrais noms d'en-tête seront inclus dans la table
Par défaut: 1
options:
0 = indique que les noms d'en-tête ne seront pas inclus dans la table
1 = indique que les noms d'en-tête seront inclus dans la table
includeimages - si vrai, les images de la page Web doivent être incluses dans le fichier DOCX
Par défaut: 1
options:
0 = indique que le document DOCX n'inclura pas d'images de page Web
1 = indique que le document DOCX inclura des images de page Web
includelinks - vrai si des liens doivent être inclus dans le document
Par défaut: 1
options:
0 = indique que le document ne doit pas inclure de liens
1 = indique que le document doit inclure des liens
includeoutline - vrai si Signets PDF devrait être inclus
Par défaut: 0
options:
0 = indique que le document PDF n'inclura pas de contour
1 = indique que le document PDF comprendra un contour
post - tous les paramètres de publication que vous souhaitez envoyer.
quality - la qualité de la capture, JPG et WEBP ont une compression par défaut de 90% et GIF de 85%. Ce paramètre n'a aucun effet sur les images BMP, PNG ou TIFF.
Réduire la qualité réduira la taille du fichier et les temps de téléchargement.
Par défaut: -1
Minimum: -1
Maximum: 100
répéter - nombre de fois pour boucler le GIF animé.
Par défaut: 0
Boucle en continu: 0
Ne jamais boucler : -1
inverser - si vrai, les images du GIF animé sont inversées
Par défaut: 0
options:
0 = indique que l'animation ne sera pas respectée
1 = indique que l'animation sera inversée
requestas - le type d'agent utilisateur que vous souhaitez utiliser
Par défaut: 0
options:
0 = indique que la version standard du site Web doit être renvoyée
2 = indique que la vue du moteur de recherche d'un site Web doit être renvoyée
vitesse - la vitesse du GIF animé.
Par défaut: 1
Minimum: 0.2
Maximum: 10
Commencez - la position de départ de la vidéo à convertir into un GIF animé.
Par défaut: secondes 0
tabletoinclude - l'index de la table à convertir, si toutes les tables d'une page Web sont ordonnées du haut de la page Web vers le bas
Par défaut: 1
target - ce paramètre spécifie le Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into un document, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi.
Par défaut: vide
target - ce paramètre spécifie le Sélecteur CSS du seul élément HTML sur la page Web cible à transformer into une image, toutes les autres parties de la page Web sont ignorées. S'il existe plusieurs éléments HTML correspondants, le premier est choisi.
Par défaut: vide
target - l'id du seul élément HTML de la page Web à utiliser pour extraire des tables de
templateid - ajouter un modèle ID qui spécifie l'en-tête et le pied de page du document
Par défaut: vide
title - donner un titre au document PDF
Par défaut: vide
waitfor - cela spécifie l'élément HTML, en utilisant un Sélecteur CSS. Une fois que l'élément est visible la capture est exécutée. S'il existe plusieurs éléments HTML correspondants, le premier est choisi. Lorsque ce paramètre est utilisé, il attend un maximum de 25 secondes avant que la capture ne soit effectuée.
width - la largeur de la vignette obtenue en pixels
Par défaut: si la largeur de sortie et la hauteur de sortie ne sont pas spécifiées ou 0, la largeur et la hauteur de sortie correspondront à la largeur et à la hauteur de l'image finale, si la hauteur de sortie est spécifiée, la largeur de sortie sera proportionnelle à la hauteur de sortie
Maximum: Largeur maximale pour le colis
Pleine largeur: -1 (passage -1 signifie que la largeur de la vignette n'est pas réduite)
largeur - la largeur du GIF animé obtenu en pixels.
Par défaut: 180px
Maximum: Largeur maximale pour le colis
Taille automatique: -1 (passage -1 signifie que la largeur de la le GIF animé est mis à l'échelle par rapport à sa hauteur, si la largeur est auto-dimensionnée, la hauteur ne peut pas)