PDF y Captura de Pantalla

PDF & Screenshot es un componente de SmartBrowz que te permite generar documentos visuales de sitios web y aplicaciones web. Es una herramienta poderosa que se puede usar para convertir páginas web a PDF, para usar durante la depuración de UI y para comprender los componentes visuales desde la perspectiva de los usuarios finales, mientras implementas operaciones de rastreo permitidas, por nombrar algunos usos.

Puedes introducir esta funcionalidad en tu aplicación Catalyst usando la API a continuación.

Generar PDF Usando HTML/URL

Descripción del PDF

Puedes usar esta API para generar documentos PDF de páginas web usando código HTML o URL como entrada.

Detalles de la Solicitud del PDF

URL de Solicitud

POST

{api-domain}/browser360/v1/project/{project_id}/convert

copy

api-domain

URL

El dominio específico del DC para acceder a la API de Catalyst

project_id

Numerical

El ID único del proyecto

Alcance

ZohoCatalyst.pdfshot.EXECUTE

Encabezados de Solicitud

Authorization: Zoho-oauthtoken {oauth_token}
Content-Type: application/json

Propiedades del JSON de Solicitud

display_header_footer boolean

optional

Pasa el valor como true para mostrar el encabezado y pie de página de la página web.
Valor predeterminado: false.

footer_template string

optional

Plantilla HTML para el pie de página de impresión. Tiene las mismas restricciones y soporte para clases especiales que PDFOptions.headerTemplate.

format PaperFormat

optional

Tamaño del papel. Ejemplo: A4, A3.

header_template string

optional

Plantilla HTML para el encabezado de impresión. Debe ser HTML válido con las siguientes clases para inyectar valores en ellas:

date string

optional

Fecha de impresión formateada

title string

mandatory

Título del documento

url string

mandatory

URL del documento

page_number string

optional

Número de página actual

total_pages string

optional

Total de páginas en el documento

landscape boolean

optional

Pasa el valor como true para imprimir en orientación horizontal

margin PDFMargin

optional

Establece los márgenes del PDF

omit_background boolean

optional

Oculta el fondo blanco predeterminado y permite generar PDFs con fondo transparente

page_ranges string

optional

Rangos de páginas a imprimir. Ejemplo: 1-5, 8, 11-13.

prefer_css_pageSize boolean

optional

Pasa el valor como true para priorizar el tamaño de @page CSS declarado en la página sobre lo declarado en la opción de ancho, alto o formato

print_background boolean

optional

Pasa el valor como true para imprimir los gráficos de fondo

scale number

optional

Escala el renderizado de la página web. Valores aceptables: entre 0.1 y 2.

timeout number

optional

Tiempo de espera en milisegundos. Pasa el valor como 0 para deshabilitar el tiempo de espera.

width string | number

optional

Establece el ancho del papel. Puedes pasar un número o una cadena con una unidad.

timeout number

optional

Tiempo máximo de espera en milisegundos. Pasa el valor como 0 para deshabilitar el tiempo de espera.

El valor predeterminado se puede cambiar usando los métodos
page.set_default_timeout() o page.set_default_navigation_timeout().

wait_until string | number

optional

Detalles de la Respuesta del PDF

La respuesta devolverá el documento PDF generado.

Generar Captura de Pantalla Usando HTML/URL

Descripción de la Captura de Pantalla

Puedes usar esta API para generar capturas de pantalla de páginas web usando código HTML o URL como entrada.

Detalles de la Solicitud de la Captura de Pantalla

URL de Solicitud

POST

{api-domain}/browser360/v1/project/{project_id}/convert

copy

project_id

Numerical

El ID único del proyecto

Alcance

ZohoCatalyst.pdfshot.EXECUTE

Propiedades del JSON de Solicitud

capture_beyond_viewport boolean

mandatory

Pasa el valor como true para capturar la captura de pantalla más allá del viewport

clip screenshot_clip

mandatory

Objeto que especifica la región de recorte de la página

encoding 'base64' | 'binary'

mandatory

Codificación de la imagen

from_surface boolean

mandatory

Pasa el valor como true para capturar la captura de pantalla desde la superficie en lugar de la vista.

full_page boolean

mandatory

Pasa el valor como true para tomar una captura de pantalla de la página completa

omit_background boolean

mandatory

Oculta el fondo blanco predeterminado y permite capturar capturas de pantalla con fondo transparente

quality number

optional

Calidad de la imagen. No aplicable a imágenes .png. Valores aceptables: entre 0 y 100. Tiempo máximo de espera en milisegundos. Pasa el valor como 0 para deshabilitar el tiempo de espera.

wait_until string | number

optional

password string

optional

Contendrá el valor de la contraseña que protege tu documento PDF.

Detalles de la Respuesta de la Captura de Pantalla

La respuesta devolverá una captura de pantalla que fue generada.

Nota: Cualquier acción o operación de navegador que codifiques usando la función Browser Logic, o cualquier tarea de automatización de navegador o web scraping que realices usando cualquier componente de Catalyst SmartBrowz es bajo tu propio riesgo. Recomendamos encarecidamente que uses los componentes de SmartBrowz para realizar operaciones en dominios que permitan las acciones, o con la aprobación adecuada. Además, aunque Catalyst proporciona una infraestructura segura para codificar tus funciones, cualquier consecuencia de la lógica que codifiques usando las funciones de Catalyst es únicamente tuya.

CURL Request - PDF from HTML/URL
copy

curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57” 

-H ‘Content-Type: application/json’
–d ‘{
“url”: “https://www.example.com”,
“output_options”: {
“output_type”: “pdf”
},
“pdf_options” : {
“scale” : 1,
“display_header_footer” : true,
“header_template” : “<style> #header, #footer { margin: 0 !important; padding: 0 !important; font-size: 9px; -webkit-print-color-adjust: exact;}</style><div style=\width:100%><span class=\date&gt;</span><span class=\title\ style=\float:right&gt;</span</div>”,
“footer_template” : “<style> #header, #footer { margin: 0 !important; padding: 0 !important; font-size: 9px; -webkit-print-color-adjust: exact;}</style><div style=\width:100%&gt;<span class=\url&gt;</span><div style=\float:right&gt;<span class=\pageNumber&gt;</span> / <span class=\totalPages&gt;</span></div></div>”,
“print_background” : false,
“landscape” : false,
“page_ranges” : “1”,
“format” : “A4”,
“width” : “100”,
“height” : “100”,
“margin” :
{
“top” : “1cm”,
“bottom” : “1cm”,
“left” : “1cm”,
“right”: “1cm”
},  

“omit_background” :  false
},
“page_options”:{
“css” : {
“content” : “body{background: lightgrey}”
},
“viewport” : {
“width”: 1440,
“height”: 900
},
“javascript_enabled” : true
},
“navigation_options”:{
“timeout” : 5000,
“wait_until” : “networkidle0”
}
}’

CURL Request - Screenshot from HTML/URL
copy

curl -X POST \ ‘https://api.catalyst.zoho.com/browser360/v1/project/10470000000272001/convert'
-H “Authorization: Zoho-oauthtoken 1000.910*************************16.2f*************************57” 

-H ‘Content-Type: application/json’
–d’{
“url”: “https://www.example.com”,
“output_options”: {
“output_type”: “screenshot”
},
“screenshot_options”: {
“type”: “jpeg”,
“quality”: 100,
“full_page”: false,
“omit_background”: false,
“capture_beyond_viewport”: true,
“clip”: {
“x”: 50,
“y”: 100,
“width”: 1000,
“height”: 100
}
},
“page_options”: {
“css”: {
“content”: “body{background: lightgrey}”
},
“viewport”: {
“width”: 1440,
“height”: 900
},
“javascript_enabled”: true
},
“navigation_options”: {
“timeout”: 5000,
“wait_until”: “networkidle0”
}
}’

Generate PDF & Screenshot- Java SDK

Generate PDF & Screenshot- Node.js SDK

Generate PDF & Screenshot- Python SDK

Yes

Thank you for your feedback!

Send your feedback to us

Skip

Submit