Document creation webhook API for Make.com

Overview

An API to invoke the document generation based on the trigger event and the data from the event.

Base URL

https://api.docsgenflow.com/make/

Authentication

API is protected by API Key authentication which need to be configured in Make scenario configuration.

Rate Limiting

No rate limits for the paid users. For free and demo accounts the rate limit is set as 5 request per minutes(only for Create document API).

Endpoints

1. User API

POST /user

Description:

For API Key authentication verification and to fetch the account information.

Parameters:

• apiToken (string): API Token for authentication purpose

Request:

GET /user?apiToken=value

Response

{
  'type':  'email',
  'value': 'user.email'
}

2. Get available Template list API

GET /template

Description:

To fetch and select templates created in Docsgenflow.com and create the scenario flow for generating the documents using the selected template document.

Parameters:

• apiToken (string): API Token for authentication purpose

Request:

GET /template?apiToken=value

Response

[
  {
    id:  templateId,
    name:  templateName,
  }
]

3. Fetch the Mergefields for the selected Template

GET /fields

Description:

To fetch the Mergefields configured in the selected template. Those fields has to be mapped with the input fields from the trigger event.

Parameters:

• apiToken (string): API Token for authentication purpose
• templateId (String): Selected templateID

Request:

GET /fields?apiToken=value1&templateId=value2

Response

[
  {
    key:  fieldName,
    childres:  [],
  }
]

4. Document generation API

GET /creatdocument

Description:

To trigger document generation process.

Parameters:

• apiToken (string): API Token for authentication purpose
• templateId (String): Selected templateID
• data (JSON) : data from the trigger

Request:

GET /createdocument?apiToken=value1&templateId=value2&data=value3

Response

  {
    status : 'success',
    data : {
      url : '<generated document url>',
      queueId : '<queueId>'
    }
  }