PDF y Captura de Pantalla con Plantilla como Entrada | SmartBrowz

Generar PDF Usando Plantillas

Nota: Necesitas crear una plantilla en la consola para usar esta API.

Descripción

Puedes usar esta API para generar documentos PDF de páginas web usando Templates 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

Propiedades del JSON de Solicitud

display_header_footer boolean

optional

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

format PaperFormat

optional

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

landscape boolean

optional

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

password string

optional

Pasa el valor de la contraseña del documento 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

password string

optional

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

Detalles de la Respuesta del PDF

La respuesta será un PDF que fue generado.

Nota:

Necesitas crear una plantilla en la consola para usar esta API.
SmartBrowz Templates te ofrece la opción de establecer una contraseña para el documento PDF que generas usando una plantilla. Si empleas la opción Set Password Manually, entonces puedes usar esta API. Esta API no se puede usar si empleas la opción Set Password Dynamically.

Generar Captura de Pantalla Usando Plantillas

Descripción de la Captura de Pantalla

Puedes usar esta API para generar capturas de pantalla de páginas web, usando Templates 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

wait_until string | number

optional

Detalles de la Respuesta de la Captura de Pantalla

La respuesta será 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 Templates
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 ‘{
“template_id”:“367000000044001”,
“template_data”:{},
“output_options”: {
“output_type”: “pdf”
},
“pdf_options” : {
“scale” : 1,
“display_header_footer” : true,
    "print_background" : false,
    "landscape" : false,
    "page_ranges" : "1",
    "format" : "A4",
    "width" : "100",
    "height" : "100",
    "omit_background" :  false,
    "password": "Demo$"
},
"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 Templates
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 ‘{
“template_id”:“367000000044001”,
“template_data”:{},
“output_options”: {
“output_type”: “pdf”
},
“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