APITemplate (Independent Publisher)

Your template id, it can be obtained in the web console(Manage Templates)

Either file or json(Default). The option json returns a JSON object, and the output PDF is stored on a CDN. Use this with the parameter expiration. The option file returns binary data of the generated PDF(Secure and completely private) and the response HTTP header Content-Disposition is set to attachment.

Expiration of the generated PDF in minutes(default to 0, store permanently). Use 0 to store on cdn permanently. Or use the range between 1 minute and 10080 minutes(7 days) to specify the expiration of the generated PDF

Either 1 or 0(Default).. To enable output of html content, set the value to 1 and it will return in the JSON response as html_url field (as a URL)

Either pdf(Default) or html.. It's generating PDF by default. However, you can specify output_format=html to generate only HTML(It will return in the JSON response as download_url field as a URL).

Default to UUID (e.g 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf). Use this to specify custom file name, it should end with .pdf

We embed the original images by default, meaning large PDF file sizes. Specifying the option 'image_resample_res' helps reduce the PDF file size by downsampling the images of the current PDF to a resolution(in DPI). Common values are 72, 96, 150, 300 and 600.

Use CMYK color profile, 1=true, 0=false. Default to '0'

Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Action to upload the PDFs/Images to your own S3, please set it to 0.

Specify an external reference ID for your own reference. It appears in the list-objects API.

Either 1 or 0(Default). 0 is synchronous call(default), 1 is asynchronous call. To generate PDF asynchronously, set the value to 1 and the API call returns immediately. Once the PDF document is generated, we will make a HTTP/HTTPS GET to your URL(webhook_url) and will retry for 3 times before giving up.. If async is set to 1, then webhook_url is mandatory

It is the URL of your webhook URL, it starts with http:// or https:// and has to be urlencoded.. If async is set to 1, then you have to specify the webhook_url. Format of Webhook callbackOnce the PDF is generated, we will initiate a HTTP/HTTPS GET call to the following URL:https://[yourwebserver.com]?&primary_url=[primary_url]&transaction_ref=[transaction_ref]&status=[status]&message=[message]. [yourwebserver.com]: The web services to handle the callback, which is the webhook_url. [primary_url]: The URL to the PDF document. [transaction_ref]: The transaction reference number. [status] : Status of the transaction, either success or error. [message] : Status messageThe following is a sample webhook call back to your serverhttps://yourwebserver.com?&primary_url=https%3A%2F%2Fpub-cdn.apitemplate.io%2F2021%2F06%2Fb692183d-46d7-3213-891a-460a5814ad3f.pdf&transaction_ref=b692183d-46d7-3213-891a-460a5814ad3f&status=success

Your template id, it can be obtained in the web console

Expiration of the generated image in minutes(default to 0, store permanently). Use 0 to store on cdn permanently. Or use the range between 1 minute and 10080 minutes(7 days) to specify the expiration of the generated image

Upload the generated PDFs/images to our storage CDN and generate a URL, default to 1. If you have configured the Post Actions in API Integration to upload the generated PDFs/Images to your own private S3, please set cloud_storage to 0. If the export_type=file, please ignore this.

Output image type(JPEG or PNG format), default to all. Options are all, jpegOnly,pngOnly.

Specify an external reference ID for your own reference. It appears in the list-objects API.

Object transaction reference

Your template id, it can be obtained in the web console(Manage Templates)

Retrieve only the number of records specified. Default to 300

Offset is used to skip the number of records from the results. Default to 0

Filtered by template id

Filtered by transaction type, options are PDF, JPEG or MERGE

Retrieve only the number of records specified. Default to 300

Offset is used to skip the number of records from the results. Default to 0

To filter the templates by either 'PDF' or 'JPEG'

To filter the templates by template id

To filter the templates by the group name

Return along with layer information for image templates, 0=false , 1=true. Default to '0'

Specify an external reference ID for your own reference. It appears in the list-objects API.

URL array. We support normal http/https URLs and data URLs. Normal URLs: URLs start with http/https, e.g: "https://fileserver.com/a1.pdf"). Data URLs: URLs prefixed with the "data:" scheme, e.g "data:application/pdf;base64,JVBERi0xLjIg..[truncated]"

Either file or json(Default). The option json returns a JSON object, and the output PDF is stored on a CDN. The option file returns binary data of the generated PDF(Secure and completely private) and the response HTTP header Content-Disposition is set to attachment. It has a file size limit of 6MB.

Expiration of the generated PDF in minutes(default to 0, store permanently). Use 0 to store on cdn permanently. Or use the range between 1 minute and 43200 minutes(30 days) to specify the expiration of the generated PDF

Upload the generated PDFs/images to our storage CDN, default to 1. If you have configured Post Action to upload the PDFs/Images to your own S3, please set it to 0.

Your template id, it can be obtained in the web console (Manage Templates)

The HTML body

The css