Convert HTML to PDF

With this function you can convert your HTML templates to PDF documents.

Input parameters

Section	Parameters	Usage	Mandatory
Document Properties	Document Title	It defines the title of the document	No
	Author	It defines the author of the document	No
	Subject	It defines the subject of the document	No
	keywords	It defines the keywords of the document.	No
	DPI	Change the DPI explicitly, by default it will be set up to 96.	No
	Grayscale	We can decide if we want to generate the PDF in gray scale or leave it as it is in the HTML content provided.	No
	Encoding	Set the default text encoding. By default is it set up to UTF-8. For instance, you can use: UTF-8, ISO-8859-1, GB2312, Windows-1251, etc.	No
	Margin Top Page	To set the margin top value of the page. By default it is 10mm.	No
	Margin Left Page	To set the margin left value of the page. By default it is 10mm.	No
	Margin Right Page	To set the margin right value of the page. By default it is 10mm.	No
	Margin Bottom Page	To set the margin bottom value of the page. By default it is 10mm.	No
Page Configuration	Page Orientation	We can define the page orientation with a single character P | Portrait | Landscape | L: P=Portrait or L=Landscape This field will be required to be filled when creating the flow.	Yes
	Page Format	We can set the page format as A4 / A5 / LETTER / width x height (100×200, etc). By default the format page selected is A4. This field will be required to be filled when creating the flow.	Yes
	Do you want to set a custom page size? *	Set a custom paper size.	No
	Page Zoom	This is the zoom to use. By default will be applied zoom factor 1.	No
	Page Offset	Set the starting page number. By default this value is set to 0. What it means that it will start from the first page.	No
	Do you want to disable external links?	If we select ‘Yes’ in this option we are making links included in the HTML content to be disabled. Otherwise, in the PDF generated links will continue be clickable.	No
	Do you want to set the viewport size? *	Set viewport size if we have custom scrollbars or CSS attribute overflow to emulate window size.	No
Headers & Footers Configuration	Header Text Center	Centered header text.	No
	Header Font Name	Set header font name. By default it be used Arial.	No
	Header Font Size	Set header font size. By default the font size is 12 pixels.	No
	Header Align Left	Left aligned header text.	No
	Header Align Right	Right aligned header text.	No
	Header Spacing	Spacing between header and content in mm. By default is not applied any spacing (value equal to 0).	No
	Do you want to display line below the header?	It displays a line below the header.	No
	Footer Text Center	Centered footer text.	No
	Footer Font Name	Set footer font name. By default it be used Arial.	No
	Footer Font Size	Set footer font size. By default the font size is 12 pixels.	No
	Footer Align Left	Left aligned footer text.	No
	Footer Align Right	Right aligned footer text.	No
	Footer Spacing	It is the spacing between the footer and the content in mm. By default is not applied any spacing (value equal to 0).	No
	Do you want to display line above the footer?	It displays a line above the footer if we select ‘Yes’ value.	No
Output Configuration	PDF name	This is the filename we want to give to it including the extension file. i.e: invoice.pdf	No

• This parameter Do you want to set a custom page size? has to possible values, “Yes” and “No”. In case of selecting “Yes”, a new section will appear with two parameters:

Section	Parameters	Usage	Mandatory
Custom Page Size configuration	Page Width	This is the page width in mm/cm. For instance: 88mm	No
	Page Height	This is the page height in mm/cm. For instance: 56mm	No

• This parameter Do you want to set the viewport size? has to possible values, “Yes” and “No”. In case of selecting “Yes”, a new section will appear with one parameter:

Section	Parameters	Usage
View	Viewport size	Set viewport size if you have custom scrollbars or CSS attribute overflow to emulate window size. For instance: 1280×1024

Response parameters

Parameter	Content
html	This is the HTML template provided in base64 encoding.
pdf_output	This is the PDF generated based on the HTML template provided in base64 encoding.
encoding	If it was set a default text encoding.
file_name	This is the PDF’s name generated.
errors	An error message if exists.