Herramientas para capturar y convertir la web

Cliente GrabzIt con Node.jsAPI Node.js

Descripción

Esta clase maneja toda la comunicación con los servicios web de captura de pantalla de GrabzIt.

Métodos públicos

get_result (id)

Este método devuelve la captura de pantalla en sí. Si no se devuelve nada, entonces algo salió mal o la captura de pantalla aún no está lista.

parámetros

  • id: el identificador único de la captura de pantalla
    • Requerido

url_to_animation(url, opciones)

Especifique la URL del video en línea que debe convertirse into un GIF animado.

parámetros

  • url: la URL del video en línea para convertir into un GIF animado
    • Requerido
    • Acepta URL de videos de Vimeo y YouTube
      • La advertencia de animación de videos de Vimeo y YouTube depende de un tercero y, por lo tanto, puede no proporcionar resultados consistentes.
  • opciones - un objeto JSON que define las opciones especiales para usar al crear el GIF animado.

Valor de retorno

vacío

Opciones de animacion

Todas las opciones disponibles al crear un GIF animado.

  • customId - Identificador personalizado que puede pasar al servicio web animado GIF. Esto se devolverá con la URL de devolución de llamada que ha especificado.
    • Predeterminado: vacío
  • width - el ancho del GIF animado resultante en píxeles.
    • Predeterminado: 180px
    • Máximo: ancho máximo para el paquete
    • Tamaño automático: -1 (pasando -1 significa que el ancho de la GIF animado se escala en relación con su altura, si el ancho se ajusta automáticamente, la altura no puede)
  • height - la altura del GIF animado resultante en píxeles.
    • Predeterminado: 120px
    • Máximo: altura máxima para el paquete
    • Tamaño automático: -1 (pasando -1 significa que la altura de la GIF animado se escala en relación con su ancho, si la altura se está dimensionando automáticamente, el ancho no puede)
  • start - la posición inicial del video que debe convertirse into un GIF animado.
    • Predeterminado: 0 segundos
  • duration - la duración en segundos del video que debe convertirse into un GIF animado.
    • Valor predeterminado: longitud máxima para el paquete
  • speed - La velocidad del GIF animado.
    • Predeterminado: 1
    • Mínimo: 0.2
    • Máxima: 10
  • framesPerSecond - la cantidad de fotogramas por segundo que deben capturarse del video.
    • Predeterminado: 10
    • Mínimo: 0.2
    • Máxima: 60
  • repeat - Número de veces para recorrer el GIF animado.
    • Predeterminado: 0
    • Bucle continuo: 0
  • reverse - si es cierto, los cuadros del GIF animado se invierten
    • Predeterminado: falso
  • customWaterMarkId - Agregar marca de agua personalizada al GIF animado
    • Predeterminado: vacío
  • quality - el calidad de la imagen devuelta, que tiene una compresión predeterminada de 85%.
    • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
    • Predeterminado: -1
    • Mínimo: -1
    • Máxima: 100
  • country - el país el GIF animado debe tomarse de.
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Valor predeterminado: la ubicación más rápida actual
    • Opciones: "SG", "Reino Unido", "EE. UU."
  • exportURL - el exportar URL que especifica dónde se debe exportar la captura también
    • Predeterminado: vacío
  • encryptionKey - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
    • Predeterminado: vacío
  • proxy - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
    • Predeterminado: vacío

Ejemplo de opciones

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

url_to_image(url, opciones)

Especifica la URL que se debe convertir into una captura de pantalla de imagen.

parámetros

  • url: la URL de la que debe estar hecha la captura de pantalla
    • Requerido
  • opciones - un objeto JSON que define las opciones especiales para usar al crear la captura de pantalla.

Valor de retorno

vacío

html_to_image(html, opciones)

Especifica el HTML que se debe convertir intuna imagen

parámetros

  • html - el HTML para convertir intuna imagen
    • Requerido
  • opciones - un objeto JSON que define cualquier opción especial para usar al crear una imagen.

Valor de retorno

vacío

file_to_image(camino, opciones)

Especifica un archivo HTML que debe convertirse intuna imagen

parámetros

  • ruta de acceso: la ruta del archivo HTML para convertir intuna imagen
    • Requerido
  • opciones - un objeto JSON que define cualquier opción especial para usar al crear una imagen.

Valor de retorno

vacío

Opciones de imagen

Todas las opciones disponibles al crear capturas de imágenes.

  • customId - Identificador personalizado que puede pasar al servicio web de captura de pantalla. Esto se devolverá con la URL de devolución de llamada que ha especificado.
    • Predeterminado: vacío
  • browserWidth - el ancho del navegador en píxeles
    • Predeterminado: 1024
    • Máxima: 10000
  • browserHeight - la altura del navegador en píxeles
    • Predeterminado: 768
    • Máxima: 10000
    • Longitud total: -1 (pasar -1 significa que se toma una captura de pantalla de toda la página web)
  • width - el ancho de la miniatura resultante en píxeles
    • Valor predeterminado: la relación más alta posible del ancho del navegador que se ajusta al ancho máximo para el paquete de usuarios
    • Máximo: ancho máximo para el paquete
    • Ancho completo: -1 (pasar -1 significa que el ancho de la miniatura no se reduce)
  • height - la altura de la miniatura resultante en mm
    • Valor predeterminado: la relación más alta posible de altura del navegador que se ajusta a la altura máxima para el paquete de usuarios
    • Máximo: altura máxima para el paquete
    • Altura completa: -1 (pasar -1 significa que la altura de la miniatura no se reduce)
  • format - el formato en el que debe estar la captura de pantalla.
    • Predeterminado: "jpg"
    • Opciones: "bmp8", "bmp16", "bmp24", "bmp", "tiff", "webp", "jpg", "png"
  • delay - el número de milisegundos a espera antes de tomar la captura de pantalla
    • Predeterminado: 0
    • Máxima: 30000
  • targetElement - la identificación o clase Selector de CSS del único elemento HTML en la página web de destino que se va a convertir into una captura de pantalla, se ignoran todas las otras partes de la página web. Si hay varios elementos HTML coincidentes, se elige el primero.
    • Predeterminado: vacío
  • hideElement - la identificación o clase Selectores CSS de uno o más elementos HTML en la página web para ocultar, para especificar múltiples elementos HTML para ocultar, separe cada selector con una coma
    • Predeterminado: vacío
  • waitForElement - la identificación o clase Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
    • Predeterminado: vacío
  • requestAs - el tipo de agente de usuario que desea utilizar
    • Predeterminado: 0
    • Opciones:
      • 0 = indica que se debe usar el agente de usuario de un navegador estándar
      • 1 = indica que se debe usar el agente de usuario de un navegador móvil
      • 2 = indica que se debe usar el agente de usuario de un motor de búsqueda
      • 3 = indica que se debe usar el agente de usuario de un navegador básico
  • customWaterMarkId - agregue una marca de agua personalizada a la imagen
    • Predeterminado: vacío
  • quality - el calidad de la imagen devuelta. Actualmente, esto solo afecta a las imágenes JPG, que tienen una compresión predeterminada de 85%.
    • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
    • Predeterminado: -1
    • Mínimo: -1
    • Máxima: 100
  • transparent - si es cierto el la captura de imagen debe ser transparente. Esto solo es compatible con imágenes png y tiff.
    • Predeterminado: falso
  • hd - si es verdad la imagen la captura será en alta definición esto duplica el tamaño de las dimensiones de la imagen.
    • Predeterminado: falso
  • country - el país la captura de pantalla debe tomarse de.
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Valor predeterminado: la ubicación más rápida actual
    • Opciones: "SG", "Reino Unido", "EE. UU."
  • exportURL - el exportar URL que especifica dónde se debe exportar la captura también
    • Predeterminado: vacío
  • encryptionKey - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
    • Predeterminado: vacío
  • noAds - si es verdad los anuncios deben ocultarse automáticamente.
    • Predeterminado: falso
  • noCookieNotifications - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
    • Predeterminado: falso
  • address - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
    • Predeterminado: vacío
  • post - define la consulta HTTP Poststring. Cada nombre y valor en la consultastring deberá estar codificado en URL. El uso de esta opción obligará a GrabzIt a realizar una publicación HTTP.
    • Predeterminado: vacío
  • proxy - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
    • Predeterminado: vacío

Ejemplo de opciones

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

url_to_rendered_html(url, opciones)

Especifica la URL que se debe convertir into HTML procesado.

parámetros

  • url: la URL de la que debe estar hecho el HTML representado
    • Requerido
  • opciones - un objeto JSON que define las opciones especiales para usar al crear el HTML representado.

Valor de retorno

vacío

html_to_rendered_html(html, opciones)

Especifica el HTML que se debe convertir into HTML procesado.

parámetros

  • html - el HTML para convertir into HTML procesado
    • Requerido
  • opciones - un objeto JSON que define cualquier opción especial para usar al crear HTML renderizado.

Valor de retorno

vacío

file_to_rendered_html(camino, opciones)

Especifica un archivo HTML que debe convertirse into HTML procesado.

parámetros

  • ruta de acceso: la ruta del archivo HTML para convertir into HTML procesado
    • Requerido
  • opciones - un objeto JSON que define cualquier opción especial para usar al crear HTML renderizado.

Valor de retorno

vacío

Opciones HTML

Todas las opciones disponibles cuando crear capturas HTML representadas.

  • customId - Identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado.
    • Predeterminado: vacío
  • browserWidth - el ancho del navegador en píxeles
    • Predeterminado: 1024
    • Máxima: 10000
  • browserHeight - la altura del navegador en píxeles
    • Predeterminado: 768
    • Máxima: 10000
  • delay - el número de milisegundos a espera antes de tomar la captura de pantalla
    • Predeterminado: 0
    • Máxima: 30000
  • waitForElement - la identificación o clase Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
    • Predeterminado: vacío
  • requestAs - el tipo de agente de usuario que desea utilizar
    • Predeterminado: 0
    • Opciones:
      • 0 = indica que se debe usar el agente de usuario de un navegador estándar
      • 1 = indica que se debe usar el agente de usuario de un navegador móvil
      • 2 = indica que se debe usar el agente de usuario de un motor de búsqueda
      • 3 = indica que se debe usar el agente de usuario de un navegador básico
  • country - el país la captura de pantalla debe tomarse de.
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Valor predeterminado: la ubicación más rápida actual
    • Opciones: "SG", "Reino Unido", "EE. UU."
  • exportURL - el exportar URL que especifica dónde se debe exportar la captura también
    • Predeterminado: vacío
  • encryptionKey - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
    • Predeterminado: vacío
  • noAds - si es verdad los anuncios deben ocultarse automáticamente.
    • Predeterminado: falso
  • noCookieNotifications - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
    • Predeterminado: falso
  • address - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
    • Predeterminado: vacío
  • post - define la consulta HTTP Poststring. Cada nombre y valor en la consultastring deberá estar codificado en URL. El uso de esta opción obligará a GrabzIt a realizar una publicación HTTP.
    • Predeterminado: vacío
  • proxy - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
    • Predeterminado: vacío

Ejemplo de opciones

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

url_to_pdf(url, opciones)

Especifica la URL que se debe convertir intoa PDF.

parámetros

  • url: la URL a la que se debe convertir intoa PDF
    • Requerido
  • opciones - un objeto JSON que define las opciones especiales para usar al crear un PDF.

Valor de retorno

vacío

html_to_pdf(html, opciones)

Especifica el HTML que se debe convertir intoa PDF.

parámetros

Valor de retorno

vacío

file_to_pdf(camino, opciones)

Especifica un archivo HTML que debe convertirse intoa PDF.

parámetros

  • ruta de acceso: la ruta del archivo HTML para convertir intoa PDF
    • Requerido
  • opciones - un objeto JSON que define las opciones especiales para usar al crear un PDF.

Valor de retorno

vacío

Opciones de PDF

Todas las opciones disponibles al crear capturas de PDF.

  • customId - un identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado.
    • Predeterminado: vacío
  • includeBackground - si es cierto, el fondo de la página web debe incluirse en la captura de pantalla
    • Predeterminado: verdadero
  • pagesize - el tamaño de página del PDF
    • Valor predeterminado: "A4"
    • Opciones: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Carta"
  • orientation - la orientación del documento PDF
    • Valor predeterminado: "Retrato"
    • Opciones: "Retrato", "Paisaje"
  • cssMediaType - el Tipo de medio CSS del documento PDF
    • Pantalla predeterminada"
    • Opciones: "Pantalla", "Print"
  • includeLinks - verdadero si los enlaces deben incluirse en el PDF
    • Predeterminado: verdadero
  • includeOutline - cierto si Marcadores PDF debe ser incluido
    • Predeterminado: falso
  • title - proporcione un título para el documento PDF
    • Predeterminado: vacío
  • coverURL - la URL de una página web que debe usarse como portada del PDF
    • Predeterminado: vacío
  • marginTop - el margen en milímetros que debería aparecer en la parte superior de la página del documento PDF
    • Predeterminado: 10
  • marginLeft - el margen en milímetros que debería aparecer a la izquierda de la página del documento PDF
    • Predeterminado: 10
  • marginBottom - el margen en milímetros que debería aparecer en la parte inferior de la página del documento PDF
    • Predeterminado: 10
  • marginRight - el margen en milímetros que debería aparecer a la derecha del documento PDF
    • Predeterminado: 10
  • browserWidth - el ancho del navegador en píxeles
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Predeterminado: 1024
    • Máxima: 10000
    • Ancho automático: -1 (pasar -1 significa que el ancho del navegador coincide con el ancho del documento PDF)
  • pageWidth - el ancho personalizado del PDF resultante en mm
  • pageHeight - el altura personalizada del PDF resultante en mm
  • delay - el número de milisegundos a espera antes de tomar la captura de pantalla
    • Predeterminado: 0
    • Máxima: 30000
  • requestAs - el tipo de agente de usuario que desea utilizar
    • Predeterminado: 0
    • Opciones:
      • 0 = indica que se debe usar el agente de usuario de un navegador estándar
      • 1 = indica que se debe usar el agente de usuario de un navegador móvil
      • 2 = indica que se debe usar el agente de usuario de un motor de búsqueda
      • 3 = indica que se debe usar el agente de usuario de un navegador básico
  • templateId - Agrega un plantilla ID que especifica el encabezado y pie de página del documento PDF
    • Predeterminado: vacío
  • targetElement - la identificación o clase Selector de CSS del único elemento HTML en la página web de destino que se va a convertir into PDF, todas las otras partes de la página web se ignoran. Si hay varios elementos HTML coincidentes, se elige el primero.
    • Predeterminado: vacío
  • hideElement - la identificación o clase Selectores CSS de uno o más elementos HTML en la página web para ocultar, para especificar múltiples elementos HTML para ocultar, separe cada selector con una coma
    • Predeterminado: vacío
  • waitForElement - la identificación o clase Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
    • Predeterminado: vacío
  • customWaterMarkId - agregue una marca de agua personalizada a cada página del documento PDF
    • Predeterminado: vacío
  • quality - el calidad del PDF devuelto. El valor predeterminado utiliza la calidad recomendada para el PDF.
    • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
    • Predeterminado: -1
    • Mínimo: -1
    • Máxima: 100
  • country - el país la captura de pantalla debe tomarse de.
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Valor predeterminado: la ubicación más rápida actual
    • Opciones: "SG", "Reino Unido", "EE. UU."
  • exportURL - el exportar URL que especifica dónde se debe exportar la captura también
    • Predeterminado: vacío
  • encryptionKey - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
    • Predeterminado: vacío
  • noAds - si es verdad los anuncios deben ocultarse automáticamente.
    • Predeterminado: falso
  • noCookieNotifications - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
    • Predeterminado: falso
  • address - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
    • Predeterminado: vacío
  • post - define la consulta HTTP Poststring. Cada nombre y valor en la consultastring deberá estar codificado en URL. El uso de esta opción obligará a GrabzIt a realizar una publicación HTTP.
    • Predeterminado: vacío
  • templateVariables - define un plantilla personalizada parámetro y valor como una consultastring. Cada nombre y valor en la consultastring deberá estar codificado en URL.
    • Predeterminado: vacío
  • proxy - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
    • Predeterminado: vacío
  • mergeId - la identificación de una captura que debería ser fusionado al comienzo del nuevo documento PDF
    • Predeterminado: vacío
  • password - el contraseña para proteger el documento PDF con
    • Predeterminado: vacío

Ejemplo de opciones

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

url_to_docx(url, opciones)

Especifica la URL que se debe convertir into DOCX.

parámetros

  • url: la URL a la que se debe convertir intoa DOCX
    • Requerido
  • opciones - un objeto JSON que define las opciones especiales para usar al crear un DOCX.

Valor de retorno

vacío

html_to_docx(html, opciones)

Especifica el HTML que se debe convertir into DOCX.

parámetros

Valor de retorno

vacío

file_to_docx(camino, opciones)

Especifica un archivo HTML que debe convertirse into DOCX.

parámetros

  • ruta de acceso: la ruta del archivo HTML para convertir intoa DOCX
    • Requerido
  • opciones - un objeto JSON que define las opciones especiales para usar al crear un DOCX.

Valor de retorno

vacío

Opciones de DOCX

Todas las opciones disponibles al crear capturas DOCX.

  • customId - un identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado.
    • Predeterminado: vacío
  • includeBackground - si es cierto, las imágenes de fondo de la página web deben incluirse en el DOCX
    • Predeterminado: verdadero
  • pagesize - el tamaño de página del DOCX
    • Valor predeterminado: "A4"
    • Opciones: "A3", "A4", "A5", "A6", "B3", "B4", "B5", "B6", "Legal", "Carta"
  • orientation - la orientación del documento DOCX
    • Valor predeterminado: "Retrato"
    • Opciones: "Retrato", "Paisaje"
  • includeLinks - verdadero si los enlaces deben incluirse en el DOCX
    • Predeterminado: verdadero
  • includeImages - si es cierto, las imágenes de la página web deben incluirse en el DOCX
    • Predeterminado: verdadero
  • title - proporcione un título para el documento DOCX
    • Predeterminado: vacío
  • marginTop - el margen en milímetros que debería aparecer en la parte superior de la página del documento DOCX
    • Predeterminado: 10
  • marginLeft - el margen en milímetros que debería aparecer a la izquierda de la página del documento DOCX
    • Predeterminado: 10
  • marginBottom - el margen en milímetros que debería aparecer en la parte inferior de la página del documento DOCX
    • Predeterminado: 10
  • marginRight - el margen en milímetros que debería aparecer a la derecha del documento DOCX
    • Predeterminado: 10
  • browserWidth - el ancho del navegador en píxeles
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Predeterminado: 1024
    • Máxima: 10000
    • Ancho automático: -1 (pasar -1 significa que el ancho del navegador coincide con el ancho del documento DOCX)
  • pageWidth - el ancho personalizado del DOCX resultante en mm
  • pageHeight - el altura personalizada del DOCX resultante en mm
  • delay - el número de milisegundos a espera antes de tomar la captura de pantalla
    • Predeterminado: 0
    • Máxima: 30000
  • requestAs - el tipo de agente de usuario que desea utilizar
    • Predeterminado: 0
    • Opciones:
      • 0 = indica que se debe usar el agente de usuario de un navegador estándar
      • 1 = indica que se debe usar el agente de usuario de un navegador móvil
      • 2 = indica que se debe usar el agente de usuario de un motor de búsqueda
      • 3 = indica que se debe usar el agente de usuario de un navegador básico
  • templateId - Agrega un plantilla ID que especifica el encabezado y pie de página del documento DOCX
    • Predeterminado: vacío
  • targetElement - la identificación o clase Selector de CSS del único elemento HTML en la página web de destino que se va a convertir into DOCX, todas las otras partes de la página web son ignoradas. Si hay varios elementos HTML coincidentes, se elige el primero.
    • Predeterminado: vacío
  • hideElement - la identificación o clase Selectores CSS de uno o más elementos HTML en la página web para ocultar, para especificar múltiples elementos HTML para ocultar, separe cada selector con una coma
    • Predeterminado: vacío
  • waitForElement - la identificación o clase Selectores CSS del elemento HTML en la página web que debe ser visible antes de realizar la captura
    • Predeterminado: vacío
  • quality - el calidad del DOCX devuelto. La calidad predeterminada de las imágenes en el DOCX es 85%.
    • Reducir la calidad reducirá el tamaño del archivo y reducirá los tiempos de descarga.
    • Predeterminado: -1
    • Mínimo: -1
    • Máxima: 100
  • country - el país la captura de pantalla debe tomarse de.
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Valor predeterminado: la ubicación más rápida actual
    • Opciones: "SG", "Reino Unido", "EE. UU."
  • exportURL - el exportar URL que especifica dónde se debe exportar la captura también
    • Predeterminado: vacío
  • encryptionKey - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
    • Predeterminado: vacío
  • noAds - si es verdad los anuncios deben ocultarse automáticamente.
    • Predeterminado: falso
  • noCookieNotifications - si es cierto, todos se encuentran comúnmente las notificaciones de cookies deben ocultarse automáticamente.
    • Predeterminado: falso
  • address - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
    • Predeterminado: vacío
  • post - define la consulta HTTP Poststring. Cada nombre y valor en la consultastring deberá estar codificado en URL. El uso de esta opción obligará a GrabzIt a realizar una publicación HTTP.
    • Predeterminado: vacío
  • templateVariables - define un plantilla personalizada parámetro y valor como una consultastring. Cada nombre y valor en la consultastring deberá estar codificado en URL.
    • Predeterminado: vacío
  • proxy - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
    • Predeterminado: vacío
  • mergeId - la identificación de una captura que debería ser fusionado al comienzo del nuevo documento DOCX
    • Predeterminado: vacío
  • password - el contraseña para proteger el documento DOCX con
    • Predeterminado: vacío

Ejemplo de opciones

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

url_to_table(url, opciones)

Especifica la URL de la que se deben extraer las tablas HTML.

parámetros

  • url: la URL para extraer tablas HTML de
    • Requerido
  • opciones - un objeto JSON que define cualquier opción especial para usar al convertir la tabla HTML.

Valor de retorno

vacío

html_to_table(html, opciones)

Especifica el HTML del que se deben extraer las tablas HTML.

parámetros

  • html: el HTML para extraer tablas HTML de.
    • Requerido
  • opciones - un objeto JSON que define cualquier opción especial para usar al convertir la tabla HTML.

Valor de retorno

vacío

file_to_table(camino, opciones)

Especifica un archivo HTML del que se deben extraer las tablas HTML.

parámetros

  • ruta: la ruta del archivo HTML para extraer tablas HTML.
    • Requerido
  • opciones - un objeto JSON que define cualquier opción especial para usar al convertir la tabla HTML.

Valor de retorno

vacío

Opciones de tabla

Todas las opciones disponibles al convertir tablas HTML a CSV, XLSX o JSON.

  • customId - un identificador personalizado que puede pasar al servicio web. Esto se devolverá con la URL de devolución de llamada que ha especificado
    • Predeterminado: vacío
  • tableNumberToInclude - el índice de la tabla que se convertirá, si todas las tablas de una página web se ordenan de arriba a abajo
    • Predeterminado: 1
  • format - el formato en que debe estar la tabla
    • Valor predeterminado: "csv"
    • Opciones: "csv", "json", "xlsx"
  • includeHeaderNames - si se incluirán nombres verdaderos de encabezado en la tabla
    • Predeterminado: verdadero
  • includeAllTables - si es verdadero, todas las tablas de la página web se extraerán y cada tabla aparecerá en una hoja de cálculo separada. Solo disponible con el formato XLSX
    • Predeterminado: falso
  • targetElement - la identificación del único elemento HTML en la página web que debe usarse para extraer tablas de
    • Predeterminado: vacío
  • requestAs - el tipo de agente de usuario que desea utilizar
    • Predeterminado: 0
    • Opciones:
      • 0 = indica que se debe usar el agente de usuario de un navegador estándar
      • 1 = indica que se debe usar el agente de usuario de un navegador móvil
      • 2 = indica que se debe usar el agente de usuario de un motor de búsqueda
      • 3 = indica que se debe usar el agente de usuario de un navegador básico
  • country - el país la captura de pantalla debe tomarse de.
    • Advertencia: esta característica está actualmente en versión beta y puede no proporcionar resultados consistentes.
    • Valor predeterminado: la ubicación más rápida actual
    • Opciones: "SG", "Reino Unido", "EE. UU."
  • exportURL - el exportar URL que especifica dónde se debe exportar la captura también
    • Predeterminado: vacío
  • encryptionKey - si se especifica una clave de cifrado AES codificada con 64 base, su captura se cifra cuando se crea. Se recomienda usar el crear método de clave de cifrado para crear la clave y el descifrar métodos para descifrar la captura cifrada como se muestra en este ejemplo.
    • Predeterminado: vacío
  • post - define la consulta HTTP Poststring. Cada nombre y valor en la consultastring deberá estar codificado en URL. El uso de esta opción obligará a GrabzIt a realizar una publicación HTTP.
    • Predeterminado: vacío
  • address - la URL para ejecutar el código HTML. Puede ser útil si el HTML que se está convirtiendo usa URL relativas para recursos como CSS e imágenes.
    • Predeterminado: vacío
  • proxy - los detalles del proxy HTTP el software del navegador debe usar para crear esta captura
    • Predeterminado: vacío

Ejemplo de opciones

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

Usar la opción callBackUrl es el método recomendado para guardar un archivo

save(callBackUrl, al completar)

Save el resultado de forma asincrónica y devuelve un identificador único, que se puede utilizar para obtener la captura de pantalla con el obtener_resultado método.

parámetros

  • callBackURL - el entrenador de animales el servicio GrabzIt debería llamar después de haber completado su trabajo
  • oncomplete (error, id): la función de devolución de llamada, que se llama cuando se recupera el id de la captura de pantalla.

save_to(saveToFile, al completar)

Save el resultado sincrónicamente sin usar una URL de devolución de llamada.

parámetros

  • saveToFile: la ruta del archivo que capturará será saved una vez que se ha completado
  • oncomplete (error, datos): la función de devolución de llamada, que se llama cuando se ha descargado la captura de pantalla. El parámetro de datos contiene los bytes de las capturas de pantalla.

get_status(id, al completar)

Obtenga el estado actual de una captura de pantalla de GrabzIt.

parámetros

  • id: el identificador único de la captura de pantalla
    • Requerido
  • Oncomplete (error, estado) - la función de devolución de llamada, que se llama cuando se recupera el estado de la captura de pantalla.
    • Requerido

get_cookies(dominio, incompleto)

Obtenga todas las cookies que GrabzIt está utilizando para un dominio en particular. Esto también puede incluir cookies definidas por el usuario.

parámetros

  • dominio: el dominio para devolver cookies
    • Requerido
  • Oncomplete (error, galletas) - la función de devolución de llamada, que se llama cuando se recuperan las cookies.
    • Requerido

set_cookie (nombre, dominio, opciones, al completar)

Establece una nueva cookie personalizada en GrabzIt, si la cookie personalizada tiene el mismo nombre y dominio que una cookie global, la cookie global se anula.

Esto puede ser útil si la funcionalidad de un sitio web está controlada por cookies.

parámetros

  • nombre: el nombre de la cookie para establecer
    • Requerido
  • dominio: el dominio del sitio web para configurar la cookie
    • Requerido
  • opciones
    • valor - el valor de la cookie
    • ruta: la ruta del sitio web con la que se relaciona la cookie
    • httponly: si es verdadero, la cookie solo se puede usar con el protocolo HTTP
    • caduca: define cuándo caduca la cookie. Pase un valor nulo si la cookie no caduca
    {
        'value':'me@example.com',
        'httponly':false
    }
    
  • oncomplete (error, éxito): la función de devolución de llamada, que se llama cuando se ha establecido la cookie. El parámetro de éxito es verdadero si la cookie se configura correctamente; de ​​lo contrario, es falso

delete_cookie (nombre, dominio, incompleto)

Eliminar una cookie personalizada o bloquear el uso de una cookie global

parámetros

  • nombre: el nombre de la cookie a eliminar
    • Requerido
  • dominio: el dominio del sitio web para eliminar la cookie
    • Requerido
  • oncomplete (error, éxito): la función de devolución de llamada, que se llama cuando se ha establecido la cookie. El parámetro de éxito es verdadero si se elimina la cookie; de ​​lo contrario, es falso.

get_watermarks ()

Obtenga todas sus marcas de agua personalizadas cargadas

parámetros

  • Oncomplete (error, marcas de agua) - la función de devolución de llamada, que se llama cuando se han recuperado las marcas de agua. El parámetro de marca de agua contiene una serie de marcas de agua.
    • Requerido

get_watermark (identificador, al completar)

Devuelva su marca de agua personalizada que coincida con el identificador especificado

parámetros

  • identificador: el identificador de una marca de agua personalizada particular que desea ver
    • Requerido
  • Oncomplete (error, marcas de agua) - la función de devolución de llamada, que se llama cuando se ha recuperado la marca de agua. El parámetro de marcas de agua contiene una matriz de marcas de agua.
    • Requerido

add_watermark (identificador, ruta, xpos, ypos, al completar)

Agregar una nueva marca de agua personalizada

parámetros

  • identificador: el identificador que desea dar a la marca de agua personalizada. Es importante que este identificador sea único.
    • Requerido
  • ruta: la ruta absoluta de la marca de agua en su servidor. Por ejemplo C: /watermark/1.png
    • Requerido
  • xpos: la posición horizontal en la que desea que aparezca la captura de pantalla
    • Requerido
    • Opciones:
      • Izquierda = 0
      • Centro = 1
      • Derecha = 2
  • ypos: posición vertical en la que desea que aparezca la captura de pantalla
    • Requerido
    • Opciones:
      • Arriba = 0
      • Medio = 1
      • Inferior = 2
  • oncomplete (error, éxito): la función de devolución de llamada, que se llama cuando se agrega la marca de agua. El parámetro de éxito es verdadero si la marca de agua se ha agregado correctamente, de lo contrario es falso.
    • Requerido

delete_watermark (identificador, al completar)

Eliminar una marca de agua personalizada

parámetros

  • identificador: el identificador de la marca de agua personalizada que desea eliminar
    • Requerido
  • oncomplete (error, éxito): la función de devolución de llamada, que se llama cuando se elimina la marca de agua. El parámetro de éxito es verdadero si la marca de agua se eliminó con éxito.
    • Requerido

set_local_proxy (valor)

Este método permite un servidor proxy local para ser utilizado para todas las solicitudes.

parámetros

  • valor: la URL, que puede incluir un puerto si es necesario, del proxy. Proporcionar un valor nulo eliminará cualquier proxy establecido previamente
    • Requerido

use_ssl (valor)

Especifica si las solicitudes a GrabzIt's API debe usar SSL

parámetros

  • valor: si es verdadero, todas las solicitudes a la API de GrabzIt utilizarán SSL
    • Requerido

create_encryption_key ()

Cree una clave de cifrado 64 base criptográficamente segura, con caracteres 44 largos.


descifrar (datos, clave)

Descifre una captura cifrada utilizando la clave de cifrado proporcionada.

parámetros


decrypt_file (ruta, clave, al completar)

Descifre una captura cifrada utilizando la clave de cifrado proporcionada.

parámetros

  • ruta: la ruta de la captura cifrada
    • Requerido
  • clave - la Clave de encriptación
    • Requerido
  • oncomplete (error): la función de devolución de llamada, que se llama cuando se descifra el archivo.

Clases de resultados

Galletas

Variables publicas

  • nombre: el nombre de la cookie
  • valor - el valor de la cookie
  • dominio: el dominio para el que se configura la cookie
  • ruta: la ruta en el dominio al que se aplica esta cookie.
  • httponly: si esta cookie solo es válida cuando el sitio web se visualiza con el protocolo HTTP.
  • caduca: la fecha de caducidad de esta cookie
  • tipo: el tipo de cookie que es
    • Opciones:
      • Global: esta es una cookie global establecida por GrabzIt
      • Local: esta es una cookie local establecida por usted
      • Anulada: una cookie global que usted ha anulado

Estatus de la Propiedad

La clase que representa el estado actual de la captura de pantalla.

Variables publicas

  • procesamiento: si es verdadero, la captura de pantalla todavía se está procesando.
  • en caché: si es verdadero, la captura de pantalla se ha procesado y actualmente está en caché.
  • expirado: si es verdadero, la captura de pantalla ya no está en el sistema GrabzIt.
  • mensaje: un mensaje de error devuelto por el sistema.

WaterMark

Esta clase representa las marcas de agua personalizadas almacenadas en GrabzIt

Variables publicas

  • identificador: el identificador de la marca de agua
  • formato: el formato de la imagen de marca de agua
  • xPosition: la posición x en la que aparece la marca de agua en la captura de pantalla
    • Opciones:
      • Izquierda = 0
      • Centro = 1
      • Derecha = 2
  • yPosition: la posición y en la que aparece la marca de agua en la captura de pantalla
    • Opciones:
      • Arriba = 0
      • Medio = 1
      • Inferior = 2