Overview

The DynamicDocs API provides a quick way to create bespoke PDF documents in bulk with the ability to include graphics and logic in the documents.

This is done by writing templates in LaTeX on our website and then calling the API with JSON data payload, which consists of dynamic data for the document. Once the call has been made, the API will send a response with a location of a status JSON file. By reading the status JSON file, you can see whether the document has been created successfully and a temporary, secure URL link is created for the client to download the document.

Not only can you create good looking documents using LaTeX, you can also create custom charts and include conditional logic into the documents with custom built-in functions. This allows you to create truly dynamic documents which only depend on the data payload.

Quick Links - Creating Charts and Putting Dynamic Data into the Template

Follow these link to the documentation on how to include bespoke charts and how to include dynamic data into templates.

API Consumption

Currently the DynamicDocs API is available directly via ADVICEment.io. To try the API for free, you can sign up for an account and you will be given our FREE plan which gives you ability to create a limited number of documents per month. For more information on other plans, visit our pricing page.

Under the Hood

Advicement utilises the Amazon Web Services infrastructure and processing capability.

Specifically, our technology stack include AWS Lambda and AWS Simple Storage Service (S3). Our AWS region is set to Western Europe (Ireland). We also make use of the 'signed URLs' to safely and securely deliver the documents to our client.

For more information regarding Amazon Web Services, please visit the AWS website.

Create Your Account

To start creating your document templates, you will need to register an account with a valid email by going to our registration page.

Registration-Page-Screenshot

Once your registration is successful, we will email you to verify your account. After verification you will be able to create templates.

Public Templates

Public templates are ready made templates available across all accounts. Using public templates is the easiest way of getting started with DynamicDocs API as no LaTeX knowledge is required. The templates have been designed by our team and their content is controlled by the JSON payload. The downside is that you are unable to make any sutom adjustments unless they are already incorporated in the public templates.

Quick Links - Public Templates

See a full list of public templates currently available with DynamicDocs API

Creating Your Own Document Template

Once registered you can start using our templates or building your own. Don't worry we have some ready made templates with which you can start. Sign in to your account and then visit My Templates page. There you can find 'New Template' button which will give you various options of templates.

Registration-Page-Screenshot
Quick Links - Ready Made Templates for You

We have ready made templates available for you. Visit our Template Examples page and see if any of them is suitable for your business case. If not, we will happily create one for you. Just drop us a message using the Support page.

Afterwards you will need to name the template and describe it. Once you have succesfully created your template, you can start making changes to it, finding it in the list and clicking on 'Edit Template' button.

Registration-Page-Screenshot

Editing an Existing Template

In the editing template section, you will be able to perform these functions:

  1. Create additional tex files
  2. Upload media files (jpg and png)
  3. Edit template files
  4. Edit JSON data payload files
  5. Save all the files
  6. Compile templates
  7. Publish templates
  8. Use the navigation menu to leave the editting template section
Registration-Page-Screenshot

Compiling a Template via the Website

By using a 'Compile' button, the website would send the JSON data payload to the API and use the template settings to create the PDF. More on those in the next section in template settings. Note that the template files used are the ones you are working with and not the ones which have been published. In other words the compile button lets you test and work with the template files in real-time.

Publishing a Template

By using the 'Publish' button, you effectively make the latest files available for consumption. By publishing again, you replace the previously published files with the current ones. Meaning, when you call the API through the end point, the template files used to create the documents will be the ones you have published last.

When you publish your template for the first time, you can view the template token available in the settings of your template. The template token is used in the path of your API call. This parameter does not change when you publish your template again.

Calling DynamicDocs API

Currenly DynamicDocs API has one resource called compile. The compile resource lets you generate the PDF document using the public template files or the template files associated with your account.

Endpoint Structure - POST

https://api.advicement.io/v1/templates/{templateToken}/compile?...

The templateToken corresponds to the id of the public template you are using or its the template token founds in your template's settings. It is a required path parameter which identifies the correct template files to be used to compile your PDF document.

The body of the request needs to be the template's JSON payload. The request needs to be authenticated with your account's API key (Adv-Security-Token) as a header parameter.

Quick Links - Authentication Guide

Please see our authentication guide to see how to authenticate your API calls.