Tools zum Erfassen und Konvertieren des Webs

GrabzIt Client mit Node.jsNode.js API

Beschreibung

Diese Klasse verwaltet die gesamte Kommunikation mit den GrabzIt-Screenshot-Webdiensten.

Öffentliche Methoden

get_result (id)

Diese Methode gibt den Screenshot selbst zurück. Wenn nichts zurückgegeben wird, ist ein Fehler aufgetreten oder der Screenshot ist noch nicht fertig.

Parameter

  • id - Die eindeutige Kennung des Screenshots
    • Erforderlich

url_to_animation(URL, Optionen)

Geben Sie die URL des Online-Videos an, das konvertiert werden soll into ein animiertes GIF.

Parameter

  • url - Die URL des zu konvertierenden Online-Videos into ein animiertes GIF
    • Erforderlich
    • Akzeptiert Vimeo- und YouTube-Video-URLs
      • Die Warnung, dass Vimeo- und YouTube-Videos animiert werden müssen, hängt von Dritten ab und liefert möglicherweise keine konsistenten Ergebnisse.
  • Optionen - Ein JSON-Objekt, das spezielle Optionen für die Erstellung des animierten GIF definiert.

Rückgabewert

ungültig

Animationsoptionen

Alle verfügbaren Optionen beim Erstellen eines animierten GIF.

  • customId - Benutzerdefinierte Kennung, die Sie an den animierten GIF-Webdienst übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • width - 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.
  • height - 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)
  • start - Die Startposition des Videos, das konvertiert werden soll into ein animiertes GIF.
    • Voreinstellung: 0 Sekunden
  • duration - Die Länge des zu konvertierenden Videos in Sekunden into ein animiertes GIF.
    • Standard: maximale Länge für das Paket
  • speed - die Geschwindigkeit des animierten GIF.
    • Standard: 1
    • Minimum: 0.2
    • Maximum: 10
  • framesPerSecond - Die Anzahl der Bilder pro Sekunde, die aus dem Video aufgenommen werden sollen.
    • Standard: 10
    • Minimum: 0.2
    • Maximum: 60
  • repeat - Häufigkeit, mit der das animierte GIF wiederholt wird.
    • Standard: 0
    • Endlosschleife: 0
  • reverse - Wenn true, werden die Frames des animierten GIF umgekehrt
    • Voreinstellung: false
  • customWaterMarkId - Fügen Sie dem animierten GIF ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • quality - der Qualität des zurückgegebenen Bildes, die eine Standardkomprimierung von 85% hat.
    • Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • country - das Land Das animierte GIF sollte entnommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportUrl - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
    • Voreinstellung: leer
  • proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

Options Beispiel

{
    'width':250,
    'height':250,
    'speed':2
}

url_to_image(URL, Optionen)

Gibt die URL an, die konvertiert werden soll into ein Bild Screenshot.

Parameter

  • url - die URL, aus der der Screenshot bestehen soll
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen des Screenshots verwendet werden sollen.

Rückgabewert

ungültig

html_to_image(html, Optionen)

Gibt den HTML-Code an, der konvertiert werden soll into ein Bild.

Parameter

  • html - das zu konvertierende HTML into ein Bild
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen eines Image verwendet werden sollen.

Rückgabewert

ungültig

file_to_image(Pfad, Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll into ein Bild.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein Bild
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen eines Image verwendet werden sollen.

Rückgabewert

ungültig

Bildoptionen

Alle Optionen, die beim Erstellen von Bilderfassungen zur Verfügung stehen.

  • customId - Benutzerdefinierte Kennung, die Sie an den Screenshot-Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • browserWidth - die Breite des Browsers in Pixel
    • Standard: 1024
    • Maximum: 10000
  • browserHeight - die Höhe des Browsers in Pixel
    • Standard: 768
    • Maximum: 10000
    • Volle Länge: -1 (Die Übergabe von -1 bedeutet, dass ein Screenshot der gesamten Webseite erstellt wird.)
  • width - die Breite des resultierenden Thumbnails in Pixel
    • Standard: Das höchstmögliche Verhältnis der Browserbreite, das in die maximale Breite des Benutzerpakets passt
    • Maximum: Maximale Breite für das Paket
    • Volle Breite: -1 (Das Übergeben von -1 bedeutet, dass die Breite des Thumbnails nicht verringert wird.)
  • height - die Höhe des resultierenden Thumbnails in mm
    • Standard: Das höchstmögliche Verhältnis der Browserhöhe, das in die maximale Höhe des Benutzerpakets passt
    • 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.)
  • format - Das Format, in dem der Screenshot angezeigt werden soll.
    • Standard: "jpg"
    • Optionen: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
  • delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • targetElement - der CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intAls Screenshot werden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
    • Voreinstellung: leer
  • hideElement - 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
  • waitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • requestAs - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
      • 3 = gibt an, dass der Benutzeragent eines Basisbrowsers verwendet werden soll
  • customWaterMarkId - Fügen Sie dem Bild ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • quality - der Qualität des zurückgegebenen Bildes. Dies betrifft derzeit nur JPG-Bilder mit einer Standardkomprimierung von 85%.
    • Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • transparent - Wenn das stimmt Die Bildaufnahme sollte transparent sein. Dies ist nur mit PNG- und TIFF-Bildern kompatibel.
    • Voreinstellung: false
  • hd - Wenn das Bild wahr ist Die Aufnahme erfolgt in High Definition Dies verdoppelt die Größe der Bildabmessungen.
    • Voreinstellung: false
  • country - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportUrl - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
    • Voreinstellung: leer
  • noAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • post - definiert die HTTP-Post-Abfragestring. Jeder Name und Wert in der Abfragestring muss URL-codiert sein. Mit dieser Option wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • Voreinstellung: leer
  • proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

Options Beispiel

{
    'width':500,
    'height':500
}

url_to_rendered_html(URL, Optionen)

Gibt die URL an, die konvertiert werden soll into gerendertes HTML.

Parameter

  • url - die URL, aus der das gerenderte HTML bestehen soll
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen des gerenderten HTML-Codes verwendet werden sollen.

Rückgabewert

ungültig

html_to_rendered_html(html, Optionen)

Gibt den HTML-Code an, der konvertiert werden soll into gerendertes HTML.

Parameter

  • html - das zu konvertierende HTML into gerendertes HTML
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen für die Erstellung von gerendertem HTML definiert.

Rückgabewert

ungültig

file_to_rendered_html(Pfad, Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll into gerendertes HTML.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into gerendertes HTML
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen für die Erstellung von gerendertem HTML definiert.

Rückgabewert

ungültig

HTML-Optionen

Alle verfügbaren Optionen bei Erstellen von gerenderten HTML-Captures.

  • customId - Benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • browserWidth - die Breite des Browsers in Pixel
    • Standard: 1024
    • Maximum: 10000
  • browserHeight - die Höhe des Browsers in Pixel
    • Standard: 768
    • Maximum: 10000
  • delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • waitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • requestAs - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
      • 3 = gibt an, dass der Benutzeragent eines Basisbrowsers verwendet werden soll
  • country - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportUrl - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
    • Voreinstellung: leer
  • noAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • post - definiert die HTTP-Post-Abfragestring. Jeder Name und Wert in der Abfragestring muss URL-codiert sein. Mit dieser Option wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • Voreinstellung: leer
  • proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

Options Beispiel

{
    'country':'SG',
    'delay':5000
}

url_to_pdf(URL, Optionen)

Gibt die URL an, die konvertiert werden soll into ein PDF.

Parameter

  • url - die URL, die konvertiert werden soll into ein PDF
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

Rückgabewert

ungültig

html_to_pdf(html, Optionen)

Gibt den HTML-Code an, der konvertiert werden soll into ein PDF.

Parameter

  • html - das zu konvertierende HTML into ein PDF
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

Rückgabewert

ungültig

file_to_pdf(Pfad, Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll into ein PDF.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei into ein PDF
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen einer PDF-Datei verwendet werden sollen.

Rückgabewert

ungültig

PDF-Optionen

Alle Optionen, die beim Erstellen von PDF-Captures zur Verfügung stehen.

  • customId - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • includeBackground - Wenn dies zutrifft, sollte der Hintergrund der Webseite im Screenshot enthalten sein
    • Voreinstellung: true
  • pagesize - die Seitengröße des PDF
    • Voreinstellung: "A4"
    • Optionen: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
  • orientation - die Ausrichtung des PDF-Dokuments
    • Standard: "Portrait"
    • Optionen: "Hochformat", "Querformat"
  • cssMediaType - der CSS-Medientyp des PDF-Dokuments
    • Standardbildschirm"
    • Optionen: "Bildschirm", "Print"
  • includeLinks - true, wenn Links in das PDF aufgenommen werden sollen
    • Voreinstellung: true
  • includeOutline - wahr wenn PDF Lesezeichen das sollte dabei sein
    • Voreinstellung: false
  • title - Geben Sie dem PDF-Dokument einen Titel
    • Voreinstellung: leer
  • coverUrl - Die URL einer Webseite, die als Deckblatt für das PDF verwendet werden soll
    • Voreinstellung: leer
  • marginTop - Der Rand in Millimetern, der oben auf der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginLeft - Der Rand in Millimetern, der links auf der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginBottom - Der Rand in Millimetern, der am unteren Rand der PDF-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginRight - Der Rand in Millimetern, der rechts vom PDF-Dokument angezeigt werden soll
    • Standard: 10
  • browserWidth - der Breite des Browsers in Pixeln
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: 1024
    • Maximum: 10000
    • Automatische Breite: -1 (Übergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des PDF-Dokuments übereinstimmt.)
  • pageWidth - der benutzerdefinierte Breite der resultierenden PDF in mm
  • pageHeight - der Benutzerdefinierte Höhe der resultierenden PDF in mm
  • delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • requestAs - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
      • 3 = gibt an, dass der Benutzeragent eines Basisbrowsers verwendet werden soll
  • templateId - füge hinzu ein Vorlage ID, die die Kopf- und Fußzeile des PDF-Dokuments angibt
    • Voreinstellung: leer
  • targetElement - der CSS-Selektor der einzige HTML-Element auf der Zielwebseite, die gedreht werden soll into ein PDFwerden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
    • Voreinstellung: leer
  • hideElement - 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
  • waitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • customWaterMarkId - Fügen Sie jeder Seite des PDF-Dokuments ein benutzerdefiniertes Wasserzeichen hinzu
    • Voreinstellung: leer
  • quality - der Qualität der zurückgegebenen PDF. Die Standardeinstellung verwendet die empfohlene Qualität für das PDF.
    • Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • country - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportUrl - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
    • Voreinstellung: leer
  • noAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • post - definiert die HTTP-Post-Abfragestring. Jeder Name und Wert in der Abfragestring muss URL-codiert sein. Mit dieser Option wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • Voreinstellung: leer
  • templateVariables - definiert a benutzerdefinierte Vorlage Parameter und Wert als Abfragestring. Jeder Name und Wert in der Abfragestring muss URL-codiert sein.
    • Voreinstellung: leer
  • proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer
  • mergeId - die ID eines Captures, das sein soll am Anfang des neuen PDF-Dokuments zusammengeführt
    • Voreinstellung: leer
  • password - der Passwort zum Schutz des PDF-Dokuments mit
    • Voreinstellung: leer

Options Beispiel

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_docx(URL, Optionen)

Gibt die URL an, die konvertiert werden soll intoa DOCX.

Parameter

  • url - die URL, die konvertiert werden soll intoa DOCX
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

Rückgabewert

ungültig

html_to_docx(html, Optionen)

Gibt den HTML-Code an, der konvertiert werden soll intoa DOCX.

Parameter

  • html - das zu konvertierende HTML intoa DOCX
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

Rückgabewert

ungültig

file_to_docx(Pfad, Optionen)

Gibt eine HTML-Datei an, die konvertiert werden soll intoa DOCX.

Parameter

  • Pfad - Der Dateipfad einer zu konvertierenden HTML-Datei intoa DOCX
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen definiert, die beim Erstellen einer DOCX verwendet werden sollen.

Rückgabewert

ungültig

DOCX-Optionen

Alle verfügbaren Optionen beim Erstellen von DOCX-Captures.

  • customId - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben.
    • Voreinstellung: leer
  • includeBackground - Wenn dies zutrifft, sollten die Hintergrundbilder der Webseite in die DOCX aufgenommen werden
    • Voreinstellung: true
  • pagesize - die Seitengröße des DOCX
    • Voreinstellung: "A4"
    • Optionen: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Letter"
  • orientation - die Ausrichtung des DOCX-Dokuments
    • Standard: "Portrait"
    • Optionen: "Hochformat", "Querformat"
  • includeLinks - true, wenn Links in die DOCX aufgenommen werden sollen
    • Voreinstellung: true
  • includeImages - Wenn dies zutrifft, sollten die Bilder der Webseite in die DOCX aufgenommen werden
    • Voreinstellung: true
  • title - Geben Sie dem DOCX-Dokument einen Titel
    • Voreinstellung: leer
  • marginTop - Der Rand in Millimetern, der oben auf der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginLeft - Der Rand in Millimetern, der links auf der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginBottom - Der Rand in Millimetern, der am unteren Rand der DOCX-Dokumentseite angezeigt werden soll
    • Standard: 10
  • marginRight - der Rand in Millimetern, der rechts vom DOCX-Dokument angezeigt werden soll
    • Standard: 10
  • browserWidth - der Breite des Browsers in Pixeln
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: 1024
    • Maximum: 10000
    • Automatische Breite: -1 (Übergabe von -1 bedeutet, dass die Breite des Browsers mit der Breite des DOCX-Dokuments übereinstimmt.)
  • pageWidth - der benutzerdefinierte Breite des resultierenden DOCX in mm
  • pageHeight - der benutzerdefinierte Höhe des resultierenden DOCX in mm
  • delay - die Anzahl der Millisekunden bis Warten Sie, bevor Sie den Screenshot aufnehmen
    • Standard: 0
    • Maximum: 30000
  • requestAs - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
      • 3 = gibt an, dass der Benutzeragent eines Basisbrowsers verwendet werden soll
  • templateId - füge hinzu ein Vorlage ID, die die Kopf- und Fußzeile des DOCX-Dokuments angibt
    • Voreinstellung: leer
  • targetElement - der CSS-Selektor des einzigen HTML-Elements auf der Zielwebseite, das gedreht werden soll intoa DOCX werden alle anderen Teile der Webseite ignoriert. Wenn mehrere übereinstimmende HTML-Elemente vorhanden sind, wird das erste ausgewählt
    • Voreinstellung: leer
  • hideElement - 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
  • waitForElement - der CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgeführt wird
    • Voreinstellung: leer
  • quality - der Qualität des zurückgesandten DOCX. Die Standardqualität der Bilder in der DOCX ist 85%.
    • Durch Verringern der Qualität wird die Dateigröße verringert und die Downloadzeit verkürzt.
    • Standardeinstellung: -1
    • Minimum: -1
    • Maximum: 100
  • country - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportUrl - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
    • Voreinstellung: leer
  • noAds - Wenn wahr Anzeigen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • noCookieNotifications - Wenn wahr, alle häufig gefunden Cookie-Benachrichtigungen sollten automatisch ausgeblendet werden.
    • Voreinstellung: false
  • address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • post - definiert die HTTP-Post-Abfragestring. Jeder Name und Wert in der Abfragestring muss URL-codiert sein. Mit dieser Option wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • Voreinstellung: leer
  • templateVariables - definiert a benutzerdefinierte Vorlage Parameter und Wert als Abfragestring. Jeder Name und Wert in der Abfragestring muss URL-codiert sein.
    • Voreinstellung: leer
  • proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer
  • mergeId - die ID eines Captures, das sein soll am Anfang des neuen DOCX-Dokuments zusammengeführt
    • Voreinstellung: leer
  • password - der Passwort zum Schutz des DOCX-Dokuments mit
    • Voreinstellung: leer

Options Beispiel

{
    'pagesize':'A5',
    'includeLinks':true
}

url_to_table(URL, Optionen)

Gibt die URL an, aus der die HTML-Tabellen extrahiert werden sollen.

Parameter

  • url - die URL, aus der HTML-Tabellen extrahiert werden sollen
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.

Rückgabewert

ungültig

html_to_table(html, Optionen)

Gibt den HTML-Code an, aus dem die HTML-Tabellen extrahiert werden sollen.

Parameter

  • html - das HTML, aus dem HTML-Tabellen extrahiert werden sollen.
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.

Rückgabewert

ungültig

file_to_table(Pfad, Optionen)

Gibt eine HTML-Datei an, aus der die HTML-Tabellen extrahiert werden sollen.

Parameter

  • path - Der Dateipfad einer HTML-Datei, aus der HTML-Tabellen extrahiert werden sollen.
    • Erforderlich
  • Optionen - Ein JSON-Objekt, das spezielle Optionen für die Konvertierung der HTML-Tabelle definiert.

Rückgabewert

ungültig

Tabellenoptionen

Alle verfügbaren Optionen beim Konvertieren von HTML-Tabellen in CSV, XLSX oder JSON.

  • customId - eine benutzerdefinierte Kennung, die Sie an den Webservice übergeben können. Dies wird mit der von Ihnen angegebenen Rückruf-URL zurückgegeben
    • Voreinstellung: leer
  • tableNumberToInclude - Der Index der zu konvertierenden Tabelle, in dem alle Tabellen einer Webseite von oben nach unten angeordnet sind
    • Standard: 1
  • format - das Format, in dem die Tabelle sein soll
    • Standard: "csv"
    • Optionen: "csv", "json", "xlsx"
  • includeHeaderNames - ob echte Headernamen in die Tabelle aufgenommen werden
    • Voreinstellung: true
  • 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
    • Voreinstellung: false
  • targetElement - Die ID des einzigen HTML-Elements auf der Webseite, aus dem Tabellen extrahiert werden sollen
    • Voreinstellung: leer
  • requestAs - die Art des Benutzeragenten, den Sie verwenden möchten
    • Standard: 0
    • Zubehör:
      • 0 = gibt an, dass der Benutzeragent eines Standardbrowsers verwendet werden soll
      • 1 = gibt an, dass der Benutzeragent eines mobilen Browsers verwendet werden soll
      • 2 = gibt an, dass der Benutzeragent einer Suchmaschine verwendet werden soll
      • 3 = gibt an, dass der Benutzeragent eines Basisbrowsers verwendet werden soll
  • country - das Land Der Screenshot sollte von genommen werden.
    • Warnung: Diese Funktion befindet sich derzeit in der Beta-Phase und liefert möglicherweise keine konsistenten Ergebnisse.
    • Standard: Der aktuell schnellste Standort
    • Optionen: "SG", "UK", "US"
  • exportUrl - der URL exportieren das gibt an, wo das Capture auch exportiert werden soll
    • Voreinstellung: leer
  • encryptionKey - Wenn ein Basis-64-codierter AES-Verschlüsselungsschlüssel angegeben ist, wird Ihr Capture beim Erstellen verschlüsselt. Es wird empfohlen, die zu verwenden Verschlüsselungsmethode erstellen den Schlüssel und die Methoden entschlüsseln um das verschlüsselte Capture wie in gezeigt zu entschlüsseln Dieses Beispiel.
    • Voreinstellung: leer
  • post - definiert die HTTP-Post-Abfragestring. Jeder Name und Wert in der Abfragestring muss URL-codiert sein. Mit dieser Option wird GrabzIt auf erzwungen Führen Sie einen HTTP-Post durch.
    • Voreinstellung: leer
  • address - Die URL, unter der der HTML-Code ausgeführt werden soll. Kann nützlich sein, wenn der zu konvertierende HTML-Code verwendet wird relative URLs für Ressourcen wie CSS und Bilder.
    • Voreinstellung: leer
  • proxy - die HTTP-Proxy-Details Die Browsersoftware sollte zur Erstellung dieses Captures verwendet werden
    • Voreinstellung: leer

Options Beispiel

{
    'format':'xlsx',
    'includeHeaderNames':true
}

Die Verwendung der Option callBackUrl ist die empfohlene Methode zum Speichern einer Datei

save(callBackUrl, oncomplete)

Save das Ergebnis asynchron und gibt eine eindeutige Kennung zurück, mit der der Screenshot mit dem abgerufen werden kann get_result Methode.

Parameter

  • callBackURL - die Handler Der GrabzIt-Dienst sollte anrufen, nachdem er seine Arbeit abgeschlossen hat
  • oncomplete (error, id) - Die Rückruffunktion, die aufgerufen wird, wenn die ID des Screenshots abgerufen wird.

save_to(saveToFile, oncomplete)

Save das Ergebnis synchron ohne Verwendung einer Rückruf-URL.

Parameter

  • saveToFile - der Dateipfad, der erfasst wird saved bis sobald es abgeschlossen ist
  • oncomplete (Fehler, Daten) - Die Rückruffunktion, die aufgerufen wird, wenn der Screenshot heruntergeladen wurde. Der Datenparameter enthält die Screenshot-Bytes.

get_status(id, oncomplete)

Holen Sie sich den aktuellen Status eines GrabzIt-Screenshots.

Parameter

  • id - Die eindeutige Kennung des Screenshots
    • Erforderlich
  • unvollständig Status) - Die Rückruffunktion, die aufgerufen wird, wenn der Screenshot-Status abgerufen wurde.
    • Erforderlich

get_cookies(Domain, unvollständig)

Holen Sie sich alle Cookies, die GrabzIt für eine bestimmte Domain verwendet. Dies kann auch benutzerdefinierte Cookies beinhalten.

Parameter

  • domain - Die Domain, für die Cookies zurückgegeben werden sollen
    • Erforderlich
  • unvollständig Kekse) - die Rückruffunktion, die aufgerufen wird, wenn die Cookies abgerufen wurden.
    • Erforderlich

set_cookie (name, domain, optionen, oncomplete)

Legt ein neues benutzerdefiniertes Cookie für GrabzIt fest. Wenn das benutzerdefinierte Cookie denselben Namen und dieselbe Domäne wie ein globales Cookie hat, wird das globale Cookie überschrieben.

Dies kann hilfreich sein, wenn die Funktionalität einer Website durch Cookies gesteuert wird.

Parameter

  • name - Der Name des zu setzenden Cookies
    • Erforderlich
  • domain - Die Domain der Website, für die das Cookie festgelegt werden soll
    • Erforderlich
  • Optionen
    • value - der Wert des Cookies
    • Pfad - Der Website-Pfad, auf den sich das Cookie bezieht
    • httponly - Wenn dies zutrifft, kann der Cookie nur mit dem HTTP-Protokoll verwendet werden
    • abläuft - Legt fest, wann der Cookie abläuft. Übergeben Sie einen Nullwert, wenn das Cookie nicht ablaufen soll
    {
        'value':'me@example.com',
        'httponly':false
    }
    
  • oncomplete (error, success) - die Rückruffunktion, die aufgerufen wird, wenn der Cookie gesetzt wurde. Der Erfolgsparameter ist true, wenn das Cookie erfolgreich gesetzt wurde, andernfalls false

delete_cookie (name, domain, oncomplete)

Löschen Sie ein benutzerdefiniertes Cookie oder blockieren Sie die Verwendung eines globalen Cookies

Parameter

  • name - Der Name des zu löschenden Cookies
    • Erforderlich
  • domain - Die Domain der Website, für die das Cookie gelöscht werden soll
    • Erforderlich
  • oncomplete (error, success) - die Rückruffunktion, die aufgerufen wird, wenn der Cookie gesetzt wurde. Der Erfolgsparameter ist true, wenn das Cookie gelöscht wird, andernfalls false.

get_watermarks ()

Holen Sie sich alle Ihre hochgeladenen benutzerdefinierten Wasserzeichen

Parameter

  • unvollständig Wasserzeichen) - die Rückruffunktion, die aufgerufen wird, wenn die Wasserzeichen abgerufen wurden. Der Parameter watermark enthält ein Array von Wasserzeichen.
    • Erforderlich

get_watermark (Identifier, oncomplete)

Geben Sie Ihr benutzerdefiniertes Wasserzeichen zurück, das der angegebenen Kennung entspricht

Parameter

  • bezeichner - Der Bezeichner eines bestimmten benutzerdefinierten Wasserzeichens, das Sie anzeigen möchten
    • Erforderlich
  • unvollständig Wasserzeichen) - die Rückruffunktion, die aufgerufen wird, wenn das Wasserzeichen abgerufen wurde. Der Parameter watermarks enthält ein Wasserzeichenarray.
    • Erforderlich

add_watermark (Bezeichner, Pfad, xpos, ypos, oncomplete)

Fügen Sie ein neues benutzerdefiniertes Wasserzeichen hinzu

Parameter

  • bezeichner - der Bezeichner, dem Sie das benutzerdefinierte Wasserzeichen geben möchten. Es ist wichtig, dass diese Kennung eindeutig ist.
    • Erforderlich
  • Pfad - der absolute Pfad des Wasserzeichens auf Ihrem Server. Zum Beispiel C: /watermark/1.png
    • Erforderlich
  • xpos - Die horizontale Position, an der der Screenshot angezeigt werden soll
    • Erforderlich
    • Zubehör:
      • Links = 0
      • Mitte = 1
      • Rechts = 2
  • ypos - vertikale Position, an der der Screenshot angezeigt werden soll
    • Erforderlich
    • Zubehör:
      • Oben = 0
      • Mittel = 1
      • Unten = 2
  • oncomplete (Fehler, Erfolg) - Die Rückruffunktion, die aufgerufen wird, wenn das Wasserzeichen hinzugefügt wurde. Der Erfolgsparameter ist true, wenn das Wasserzeichen erfolgreich hinzugefügt wurde, andernfalls false.
    • Erforderlich

delete_watermark (Identifier, oncomplete)

Löschen Sie ein benutzerdefiniertes Wasserzeichen

Parameter

  • bezeichner - Der Bezeichner des benutzerdefinierten Wasserzeichens, das Sie löschen möchten
    • Erforderlich
  • oncomplete (Fehler, Erfolg) - Die Rückruffunktion, die aufgerufen wird, wenn das Wasserzeichen entfernt wurde. Der Erfolgsparameter ist true, wenn das Wasserzeichen erfolgreich gelöscht wurde.
    • Erforderlich

set_local_proxy (Wert)

Diese Methode ermöglicht a lokaler Proxy-Server für alle Anfragen zu verwenden.

Parameter

  • value - Die URL des Proxys, die bei Bedarf einen Port enthalten kann. Wenn Sie eine Null angeben, werden alle zuvor festgelegten Proxys entfernt
    • Erforderlich

use_ssl (Wert)

Gibt an, ob Anfragen an GrabzIt gesendet werden sollen API sollte SSL verwenden

Parameter

  • value - Wenn true, verwenden alle Anforderungen an die GrabzIt-API SSL
    • Erforderlich

create_encryption_key ()

Erstellen Sie einen kryptografisch sicheren Basis-64-Verschlüsselungsschlüssel mit 44-Zeichen.


entschlüsseln (Daten, Schlüssel)

Entschlüsseln Sie ein verschlüsseltes Capture mit dem angegebenen Verschlüsselungsschlüssel.

Parameter


entschlüsselungsdatei (pfad, schlüssel, oncomplete)

Entschlüsseln Sie ein verschlüsseltes Capture mit dem angegebenen Verschlüsselungsschlüssel.

Parameter

  • Pfad - Der Pfad der verschlüsselten Erfassung
    • Erforderlich
  • Schlüssel - der Verschlüsselungsschlüssel
    • Erforderlich
  • oncomplete (Fehler) - Die Rückruffunktion, die aufgerufen wird, wenn die Datei entschlüsselt wird.

Ergebnisklassen

Cookies

Öffentliche Variablen

  • name - der Name des Cookies
  • value - der Cookie-Wert
  • domain - Die Domain, für die das Cookie gesetzt ist
  • Pfad - Der Pfad in der Domäne, für die dieses Cookie gilt.
  • httponly - wenn dieses Cookie nur gültig ist, wenn die Website mit dem HTTP-Protokoll angezeigt wird.
  • abläuft - das Datum, an dem dieses Cookie abläuft
  • Typ - Die Art des Cookies
    • Zubehör:
      • Global - Dies ist ein globales Cookie, das von GrabzIt gesetzt wird
      • Lokal - Dies ist ein von Ihnen festgelegtes lokales Cookie
      • Überschrieben - Ein globales Cookie, das von Ihnen überschrieben wurde

Kategorie

Die Klasse, die den aktuellen Status des Screenshots darstellt.

Öffentliche Variablen

  • Verarbeitung - Wenn dies zutrifft, wird der Screenshot noch verarbeitet.
  • zwischengespeichert - Wenn true, wurde der Screenshot verarbeitet und wird derzeit zwischengespeichert.
  • abgelaufen - wenn true, befindet sich der Screenshot nicht mehr auf dem GrabzIt-System.
  • message - eine vom System zurückgegebene Fehlermeldung.

WaterMark

Diese Klasse repräsentiert die in GrabzIt gespeicherten benutzerdefinierten Wasserzeichen

Öffentliche Variablen

  • bezeichner - der bezeichner des wasserzeichens
  • format - das Format des Wasserzeichenbildes
  • xPosition - Die x-Position, an der das Wasserzeichen auf dem Screenshot angezeigt wird
    • Zubehör:
      • Links = 0
      • Mitte = 1
      • Rechts = 2
  • yPosition - Die y-Position, an der das Wasserzeichen auf dem Screenshot angezeigt wird
    • Zubehör:
      • Oben = 0
      • Mittel = 1
      • Unten = 2