⚙️page_pdf API parameters

Use all of our below options to personalize your pdf creation

API documentation: https://docmaker.co/API

Endpoint URL: https://api.v2.docmaker.co/page_pdf

List of API call parameters:

ParameterValues enumDecription

"url"

Required. URL of the webpage which you would like to print to pdf.

"name"

Name of the result file, has to include the extension (.pdf or .docx)

"pageSize"

"letter", "legal", "tabloid", "a3", "a4", "a5", "full_length"

Required. Size of the pdf file which you would like to print. If you chose 'full_length' the whole webpage will be printed into 1 long pdf without page breaks.

"loadTime"

Optional. Minimum loading time which you want to set for your page before triggering the export to pdf. Useful for pages with long loading time.

"pageRanges"

Optional. Page ranges to print to pdf. Examples : 1 or 2-4 or 3-7, 8-9. Leave empty if you want to print the whole document.

"landscape"

true,

false

Required. Define your page orientation: true for landscape, false for portrait.

"metadata"

Free text field, where you can store any useful data to identify a specific docMaker API call in the logs

"upload_output_file"

true,false

Boolean parameter, defining whether result files should be uploaded to docMaker S3 buckets (files are deleted after 48 hours). Should be set to "yes" for most API calls. Except for Bubble.io, for which this can be set to "yes" if you chose to upload the result file to Bubble (see Bubble plugins specific parameters).

"privateUpload"

true,false

Boolean parameter, if set to "yes", your result files will be uploaded to a private S3 bucket. You will get a presigend URL valid for 2 hours.

"getBase64"

Optional. If "true", your output file will be sent in base64 format in the JSON response.

"marginLeft"

Optional. Size of the left margin in pixels or in centimeters.

"marginRight"

Optional. Size of the right margin in pixels or in centimeters.

"marginTop"

Optional. Size of the top margin in pixels or in centimeters.

"marginBottom"

Optional. Size of the bottom margin in pixels or in centimeters.

"timeZone"

Optional. Timezone to be used by docMaker server when accessing your webpage for printing. See ICU meta zones Capo mastro (https://source.chromium.org/chromium/chromium/deps/icu.git/+/faee8bc70570192d82d2978a71e2a615788597d1:source/data/misc/metaZones.txt)

"language"

Optional. Browser language (locale) to be used by docMaker server when accessing your webpage for printing, according to ISO 3166-1 standard. List here: https://lingohub.com/developers/supported-locales/language-designators-with-regions

"vWidth"

Optional. Viewport width: width of the viewport to be used by docMaker when loading your page before exporting to pdf. Unit: pixels.

"vHeight"

Optional. Viewport height: height of the viewport to be used by docMaker when loading your page before exporting to pdf. Unit: pixels. Recommended height for full page printing : 600px

"showFooter"

"noFooter", "pageNumbers",

"customFooter"

Optional. Chose wether you want to displaya footer on each pdf page.

"htmlFooter"

Optional. If you have selected "customFooter" above, provide here Html footer code to be displayed on each page printed to pdf. Must include div position.

"webhook_url"

URL of the webhook where you want the result file to be sent.

"webhook_token"

You may provide an auth token in order to authenticate the webhook call to your server. docMaker will add it as a Bearer token in the "Authorization" header of the webhook API call.

"webhook_object_id"

Free text field, which you can use to help your backend identifiy the object to which the docMaker result_file should be attached.

"webhook_object_type"

Free text field, which you can use to help your backend identifiy the table to which the docMaker result_file should be attached.

Last updated