Machen Sie Website-Screenshots mit unserer RESTful Screenshot-API
Mit der REST-API von GrabzIt können Sie URLs oder HTML-Code vollständig mithilfe von RESTful-Techniken erfassen. Bevor Sie beginnen, lesen Sie bitte die folgenden Vorsichtsmaßnahmen sorgfältig durch. Je nach Anwendungsfall ist eine unserer anderen API-Lösungen möglicherweise besser geeignet.
- Einige Funktionen wie das Zusammenführen und Verschlüsseln von Captures sind über diese REST-API nicht verfügbar. Um diese Funktionen nutzen zu können, müssen Sie eine andere verwenden API-Bibliothek
- Verwenden Sie diese API nicht auf der Clientseite, da sonst Ihr Anwendungsschlüssel verfügbar gemacht wird! Verwenden Sie stattdessen die JavaScript-API
Wählen Sie zunächst aus dem folgenden Filter aus, was Sie tun möchten, und die verfügbaren Parameter werden zusammen mit einem einfachen Beispiel angezeigt.
Nachfolgend finden Sie die API-URL, die für alle REST-API-Aufrufe verwendet wird. Bitte achten Sie bei Anfragen darauf alle Parameterwerte sind URL-codiert.
Nachfolgend finden Sie die API-URL, die für alle REST-API-Aufrufe verwendet wird. Beim Konvertieren von HTML müssen alle Parameter vorhanden sein im Anfragetext gepostet als Schlüssel-Wert-Paare. Stellen Sie sicher, dass alle Parameterwerte URL-codiert sind und dass der Inhaltstyp ist application / x-www-form-urlencoded.
Die Erfassung wird dann in der HTTP-Antwort zurückgegeben. Die folgenden zusätzlichen Optionen sind auch für diese Art der Erfassung verfügbar, die alle optional sind, mit Ausnahme der als erforderlich gekennzeichneten. Beim Testen der API-Funktionalität empfehlen wir die Verwendung Postman um den Prozess zu vereinfachen.
URL - die URL zum Capture.
Erforderlich
html - das HTML zum konvertieren.
Erforderlich
Bei der Konvertierung von HTML müssen Sie einen HTTP-POST verwenden.
callback
- Die URL des Handlers GrabzIt sollte nach Abschluss seiner Arbeit aufrufen.
Informationen zum Erstellen eines Handlers finden Sie in der Dokumentation zu den einzelnen Sprachen ASP.NET, Javac, Node.js, Perl, PHP, Python und Ruby.
benutzerdefinierte - die benutzerdefinierte Kennung, die Sie der Erfassung zuordnen können.
Dies wird mit jeder von Ihnen angegebenen Rückruf-URL zurückgegeben.
Format - Das Format, in dem die Aufnahme erfolgen soll.
Voreinstellung: jpg
Zubehör:
bmp8
bmp16
bmp24
bmp
csv
gif
html
jpg
JSON
pdf
docx
png
seo
tiff
mp4
webp
XLSX
address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann hilfreich sein, wenn für die zu konvertierende HTML relative URLs zu Ressourcen wie CSS und Bildern verwendet werden.
Voreinstellung: leer
background - Wenn dies zutrifft, sollte der Hintergrund der Webseite in das PDF aufgenommen werden
Standard: 1
Zubehör:
0 = gibt an, dass das PDF-Dokument den Hintergrund der Webseite nicht enthalten soll
1 = gibt an, dass das PDF-Dokument den Hintergrund der Webseite enthalten soll
background - Wenn dies zutrifft, sollten die Hintergrundbilder der Webseite in die DOCX aufgenommen werden
Standard: 1
Zubehör:
0 = gibt an, dass das DOCX-Dokument keine Hintergrundbilder für Webseiten enthalten soll
1 = gibt an, dass das DOCX-Dokument die Hintergrundbilder der Webseite enthalten soll
bwidth - die Breite des Browsers in Pixel
Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
Standard: 1366
Maximum: 10000
Automatische Breite: -1 (Übergabe von -1 bedeutet, dass das Breite des Browsers entspricht der Breite des Dokuments)
bheight - die Höhe des Browsers in Pixel.
Standard: 1170
Maximum: 10000
Volle Länge: -1 (Die Übergabe von -1 bedeutet, dass ein Screenshot der gesamten Webseite erstellt wird.)
click - Dies gibt das HTML-Element mit a an CSS-Selektor klicken. Denken Sie daran, dass auch eine Verzögerung erforderlich sein kann, um die Auswirkungen des Klicks anzuzeigen
Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
country - das Land Der Screenshot / das Capture sollte von stammen.
Standard: Der aktuell schnellste Standort
Optionen: "SG", "UK", "US"
coverurl - Die URL einer Webseite, die als Deckblatt für das PDF verwendet werden soll
height - Die Höhe des resultierenden Thumbnails in Pixel
Standard: Wenn sowohl die Ausgabebreite als auch die Ausgabehöhe nicht angegeben sind oder 0, stimmen die Ausgabebreite und -höhe mit der endgültigen Bildbreite und -höhe überein. Wenn die Ausgabebreite angegeben wird, ist die Ausgabehöhe proportional zur Ausgabebreite
Maximum: Maximale Höhe für das Paket
Volle Höhe: -1 (Das Übergeben von -1 bedeutet, dass die Höhe des Thumbnails nicht verringert wird.)
Volle Länge: -1 (die Übergabe von -1 bedeutet, dass die Seitenhöhe der Webseite entspricht)
Höhe - Die Höhe des resultierenden animierten GIF in Pixel.
Standard: 120px
Maximum: Maximale Höhe für das Paket
Automatische Größe: -1 (Übergabe von -1 bedeutet, dass die Höhe des animiertes GIF wird skaliert in Bezug auf die Breite, wenn die Höhe automatisch angepasst wird, kann die Breite nicht)
hide - der CSS-Selektoren Wenn Sie festlegen möchten, dass mehrere HTML-Elemente auf der Webseite ausgeblendet werden sollen, trennen Sie jeden Selektor durch ein Komma.
Voreinstellung: leer
includealltables - Wenn true, werden alle Tabellen auf der Webseite extrahiert, wobei jede Tabelle in einem separaten Arbeitsblatt angezeigt wird.
Nur im XLSX-Format verfügbar
Standard: 0
Zubehör:
0 = gibt an, dass nicht alle Tabellen extrahiert werden
1 = gibt an, dass alle Tabellen extrahiert werden
includeheadernames - ob echte Headernamen in die Tabelle aufgenommen werden
Standard: 1
Zubehör:
0 = gibt an, dass die Headernamen nicht in die Tabelle aufgenommen werden
1 = gibt an, dass die Headernamen in die Tabelle aufgenommen werden
includeimages - Wenn dies zutrifft, sollten die Bilder der Webseite in die DOCX aufgenommen werden
Standard: 1
Zubehör:
0 = gibt an, dass das DOCX-Dokument keine Webseitenbilder enthält
1 = gibt an, dass das DOCX-Dokument Webseitenbilder enthält
includelinks - true, wenn Links in das Dokument aufgenommen werden sollen
Standard: 1
Zubehör:
0 = gibt an, dass das Dokument keine Links enthalten soll
1 = gibt an, dass das Dokument Links enthalten soll
includeoutline - wahr wenn PDF Lesezeichen das sollte dabei sein
Standard: 0
Zubehör:
0 = gibt an, dass das PDF-Dokument keine Gliederung enthält
1 = gibt an, dass das PDF-Dokument eine Gliederung enthält
proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
post - alle Post-Parameter, die Sie senden möchten.
quality - der Qualität der Aufnahme, JPG und WEBP haben eine Standardkomprimierung von 90% und GIF von 85%. Dieser Parameter hat keine Auswirkung auf BMP-, PNG- oder TIFF-Bilder.
Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
Standardeinstellung: -1
Minimum: -1
Maximum: 100
wiederholen - Häufigkeit, mit der das animierte GIF wiederholt wird.
Standard: 0
Endlosschleife: 0
Schleife nie: -1
rückgängig machen - Wenn true, werden die Frames des animierten GIF umgekehrt
Standard: 0
Zubehör:
0 = zeigt an, dass die Animation nicht erneut gewertet wird
1 = zeigt an, dass die Animation umgekehrt wird
requestas - die Art des Benutzeragenten, den Sie verwenden möchten
Standard: 0
Zubehör:
0 = gibt an, dass die Standardversion der Website zurückgegeben werden soll
1 = gibt das an mobile Version einer Website sollte zurückgegeben werden
2 = Gibt an, dass die Suchmaschinenansicht einer Website zurückgegeben werden soll
Geschwindigkeit - die Geschwindigkeit des animierten GIF.
Standard: 1
Minimum: 0.2
Maximum: 10
Anfang - Die Startposition des Videos, das konvertiert werden soll into ein animiertes GIF.
Voreinstellung: 0 Sekunden
Anfang – die Startzeit in Sekunden nach dem Laden, von der aus das Video aufgenommen werden soll.
Voreinstellung: 0 Sekunden
tabletoinclude - Der Index der zu konvertierenden Tabelle, in dem alle Tabellen einer Webseite von oben nach unten angeordnet sind
Standard: 1
target - Dieser Parameter gibt das an CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll into Ein Dokument, alle anderen Teile der Webseite werden ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt.
Voreinstellung: leer
target - Dieser Parameter gibt das an CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll into ein Bild, werden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt.
Voreinstellung: leer
target - Die ID des einzigen HTML-Elements auf der Webseite, aus dem Tabellen extrahiert werden sollen
templateid - füge hinzu ein Vorlage ID, die die Kopf- und Fußzeile des Dokuments angibt
Voreinstellung: leer
title - Geben Sie dem PDF-Dokument einen Titel
Voreinstellung: leer
waitfor - Dies gibt das HTML-Element mit a an CSS-Selektor. Sobald das Element ist sichtbar wird das Capture ausgeführt. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt. Wenn dieser Parameter verwendet wird, wartet er maximal 25 Sekunden, bevor die Erfassung durchgeführt wird.
width - die Breite des resultierenden Thumbnails in Pixel
Standard: Wenn sowohl die Ausgabebreite als auch die Ausgabehöhe nicht angegeben sind oder 0, stimmen die Ausgabebreite und -höhe mit der endgültigen Bildbreite und -höhe überein. Wenn die Ausgabehöhe angegeben wird, ist die Ausgabebreite proportional zur Ausgabehöhe
Maximum: Maximale Breite für das Paket
Volle Breite: -1 (Das Übergeben von -1 bedeutet, dass die Breite des Thumbnails nicht verringert wird.)
Breite - die Breite des resultierenden animierten GIF in Pixel.
Standard: 180px
Maximum: Maximale Breite für das Paket
Automatische Größe: -1 (Übergabe von -1 bedeutet, dass die Breite des animiertes GIF wird skaliert In Bezug auf die Höhe kann die Höhe nicht angepasst werden, wenn die Breite automatisch angepasst wird.
Nutzerdetails
Holen Sie sich mit diesem einfachen Anruf Ihr Girokontopaket und das Restguthaben.
Fügen Sie mit diesem einfachen Aufruf eine URL hinzu, die Sie von Ihrer App aus überwachen möchten. Dadurch wird ein JSON-Objekt des Webmonitors einschließlich seiner Kennung zurückgegeben.
Rückruf-URL – der Webhook zur Benachrichtigung über eine Änderung.
E-Mail - die E-Mail-Adresse zur Benachrichtigung über eine Änderung.
wiederholen - wie oft in Minuten die URL auf eine Änderung überprüft werden soll.
CSS-Selektor – der CSS-Selektor, der verwendet werden soll, um zu identifizieren, welcher Teil der Webseite überwacht werden soll.
Angeben :root um die gesamte Webseite zu überwachen
https://api.grabz.it/services/monitor?key=Sign in to view your Application Key&url=https://www.astropioneer.blog&email=hello@example.com&repeat=60&cssselector=%23id1
Monitor löschen
Um einen Webmonitor zu löschen, geben Sie einfach seine ID zusammen mit Ihrem Anwendungsschlüssel an. Sie erhalten die ID, wenn Sie den Monitor über die oben beschriebene Webmethode „Monitor hinzufügen“ erstellen. Bei Erfolg wird im Ergebnisattribut „true“ zurückgegeben.
Wenn es ein Problem mit der von Ihnen an die API gestellten Anfrage gibt, wird ein JSON-Objekt zurückgegeben, das den Fehler erklärt. Der beste Weg, dies festzustellen, besteht darin, den Inhaltstyp der Antwort vor der Verarbeitung zu überprüfen, falls dies der Fall ist application/json Ein Fehler ist aufgetreten. Der im JSON gefundene Fehlercode folgt dem Standardliste von Codes.
{
"Result": false,
"Code":"URL is missing",
"Message":100
}