PDF Generator API
Go to website
Back
Articles on:
Q&A
Frequently asked questions and answers
How to use the editor?
Introduction Text Expanded text ed
Very popular
Is it possible to conditionally change the component style or hide the component?
It is possible to conditionally hide and style the component. If you right-click on the component, you can use conditional formatting functionality, where you can either change the component style or hide the component if matches the condition. Right click on the component --> Conditional formatting Examples If you want to show only unique values of your array, you can use "Hide component if
Popular
How to share templates with other workspaces?
To share your templates with all of your users, you need to Publish your template and set the template access type to Organization. If you just want to allow other Master Users to modify your templates you need to set the template access type to Organization and keep the templates as Draft. Once the template is finalized you can Publish it to make it available for all your users. : Thai Open Sans: Greek, Cyrillic, Latin SimHei: Chinese, Cyrillic, Japanese, Latin Source Han Sans: Chinese, Cyrill
Some readers
Is it possible to have multiple users and allow them to manage their templates?
The PDF Generator API provides a workspace logic that allows creating a separate workspace for each of your customers. When you sign up, you will have an independent "organization", and the email you used in the signup process is the identifier for the "Master User". Whenever you make an API request with a unique workspace identifier, a new workspace is created automatically. All templates created within a workspace are only visible to that specific workspace. You can also create default templa
Some readers
How to integrate with Zapier?
You can find our Zapier app here: Zapier allows transferring generated documents from one system to another. In case you would like to learn more about the background of the Zapier or get more inputs how you can use it, feel free to read our article at Medium In this tutorial, we present an example of the
Some readers
What is a Sandbox account?
The Sandbox account is a fully functional PDF Generator API account, which is free to use for the integration process and testing the service. Once you are ready to go production you can just upgrade your account and all your users and templates are available after the upgrade. You can find more information about the API integration here.
Some readers
Is it possible to deploy PDF Generator API on premises?
Yes, we do offer an "on premises" deployment where we will ship the entire source code of PDF Generator API and you need to host it in your own servers. We don't limit the number of servers you use to scale vertically. We will also ship bash scripts which automate the version upgrades and deployment tasks. Please contact sales@pdfgeneratorapi.com for more information about the solution and pricing.
Some readers
What are "merges per month"?
Making an API request to merge template and data is a “merge” action. One unique PDF/HTML generated through the API is counted as one “merge”.
Some readers
How to add page numbers?
To display page numbers, you can use special placeholders {current_page} and {total_pages} in Text component. At the moment the Text component must be in a Header or Footer component to display the page number properly. Placeholders Display current page number: {current_page} Display total number of pages: {total_pages} Example Page: {current_page} / {total_pages}
Few readers
How can I render other components behind the Image component?
If the Image component is placed on the "paper" then it is always rendered as the first layer and you cannot render other components behind the Image component. To overcome this limitation you can place the Image and other components into the Container component, where the layer order is respected and you can send the required component(s) (using right click "Send to back" ) behind the Image. This way all components are rendered correctly.
Few readers
How to copy a template from one worskpace to another?
1. Copy option using Export/Import Open the template, which you need to copy, in the editor and select File > Export Open the editor from a worskpace where you want to use the template for an user with Admin panel view Use File > Import to import template
Few readers
What does the "white label" mean in the Enterprise plan?
The "white label" in the Enterprise plan means that you can have a custom theme for the editor that matches your software UI colour scheme and we also deploy the entire solution in separate instances so you can use your own subdomain for the editor and API calls.
Few readers
What is the difference between master and regular user?
A master user can manage other workspaces and also create and manage templates with organisation access type. The master user can log in to admin panel using email and password. The regular user can only modify templates in their workspace and they access the editor only via the API. Master Workspace / Master User A master workspace is the main/default workspace of your Organization. The email you signed up with is the Master Workspace identifier. Regular Workspace / Regular Use
Few readers
Is PDF Generator API GDPR compliant?
Yes, PDF Generator API is GDPR compliant. We don't store any data used to generate the document or the generated document itself. We only store the template structure and any static text which is added to the template. The cloud service is hosted in Amazon Web Services U.S east region If you need to keep the data processing in European Union then it is possible to deploy the solution in European AWS region as part of Enterprise plan. For more details, please see the "Data Processing Agreement"
Few readers
How can I format the input and output for a date or a date-time?
Input Format Date If the input format in your JSON dataset is YYYY-MM-DD (e.g. 2019-08-03) then the input format has to be the same in the editor. Input date Datetime Let's say the input format in your JSON dataset is YYYY-MM-DDTHH:mm:ss.SSSZ (e.g.
Few readers
Unable to add new credit card, system responses "Failed to verify the credit card: Do Not Honor".
The "Do No Honor" error is returned by our payment provider if your bank is unwilling to accept the transaction. You would need to contact your bank for more details regarding this generic decline. We use Braintree Payments as our payment partner. Our current payment provider is Braintree Payments.
Few readers
How to restore a previous version of the template?
You can control versions of templates and have "backups" available when navigating to the template in the admin panel. Control versions of templates 1. In the Admin Panel search for the workspace where you have template with which you need to work **2. Choose the specific template ** **3. Choo
Few readers
How to set up POSTMAN to create your first API call?
You can download our Postman collection here: Postman allows you to easily test all the API endpoints without developing and coding. In this tutorial, we will cover: JWT introduction, definition Generation of your own token Setting up the Postman app Input the JWT token to the Postman app Create a template using Postman - your first API call Merge a template with your JSON data using Postman In case you would li
Few readers
How to access a specific array elements?
It is possible to use expression language to access specific items in an array if a numeric keys are used. The array can contain strings, number or objects. Access array at index 1 {% {array_with_strings}[1] %} => "test_2" Access array at index 1 and display value of "item" {% {array_with_objects}[1]["item"] %} => "test_2" Example JSON
Few readers