Getting Started | DynamicDocs API | ADVICEment

Overview

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

This is done by writing templates in Latex on this 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 progress.json. By reading the progress.json, you can see whether the document has been created successfully and a temporary URL link is created for the client to download the document.

In addition to creating really 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 bespoke 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 the templates.

API Consumption

Currently the API is available via RapidAPI.com and via direct consumption. To try the API for free, you may open an account with RapidAPI (or use an existing one if you have it) and subscribe to 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 or go to directly to RapidAPI.com.

The direct approach is suitable for clients who require high volume of documents, dynamic charts as well as custom functionality. Pricing is done case-by-case basis and subject to any specific requirements. Typically enterprise clients enjoy prices which start from $0.05 per document.

Lastly, we plan to integrate with other services and will update this page once we complete the integration and post the news on the Advicement Blog.

Under the Hood

Currently we make use of 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.

Creating an Account with Us

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

After succeful registration, we will send you a link in your email to confirm the account. You will now be ready to create templates.

Starting a New Template

Once registered you can start using our templates or building your own. Don't worry we don't have any rights in taking your own developed work, but you are free to use ours. 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 editting template section, you will be able to perform the following 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 the template
  7. Publish the template
  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 a 'Publish' button, you effectively make the current files you are working available for consumption. By publishing, you replace the previously published files with the current ones. In other words, when you call the API through the end point, the template files used to create the documents will be the ones you have published.