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 - das 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 - das 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 - die ID oder Klasse 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 - die ID oder Klasse 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 - die ID oder Klasse 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 - das 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 - das 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 - die ID oder Klasse 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 - das 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 - das 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 - das 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 - das benutzerdefinierte Breite der resultierenden PDF in mm
  • pageHeight - das 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 - die ID oder Klasse 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 - die ID oder Klasse 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 - die ID oder Klasse 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 - das 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 - das 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 - das 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 - das 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 - das benutzerdefinierte Breite des resultierenden DOCX in mm
  • pageHeight - das 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 - die ID oder Klasse 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 - die ID oder Klasse 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 - die ID oder Klasse CSS-Selektoren des HTML-Elements in der Webseite, die muss sichtbar sein, bevor die Erfassung durchgef├╝hrt wird
    • Voreinstellung: leer
  • quality - das 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 - das 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 - das 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 - das 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