Andy Tran

Demo

Introduction

PDF Generator API allows you easily generate transactional PDF documents and reduce the development and support costs by enabling your users to create and manage their document templates using a browser-based drag-and-drop document editor.

The PDF Generator API features a web API architecture, allowing you to code in the language of your choice. This API supports the JSON media type, and uses UTF-8 character encoding.

Authentication

The PDF Generator API uses JSON Web Tokens (JWT) to authenticate all API requests. These tokens offer a method to establish secure server-to-server authentication by transferring a compact JSON object with a signed payload of your account’s API Key and Secret. When authenticating to the PDF Generator API, a JWT should be generated uniquely by a server-side application and included as a Bearer Token in the header of each request.

JSONWebTokenAuth

JSON Web Token (JWT) is an open standard (RFC 7519) that defines a compact and self-contained way for securely transmitting information between parties as a JSON object. This information can be verified and trusted because it is digitally signed. JWTs can be signed using a secret (with the HMAC algorithm) or a public/private key pair using RSA or ECDSA. For more information about JSON Web Tokens check jwt.io.

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: JWT

Merge PDFs

Returns a list of templates available for the authenticated workspace

AUTHORIZATIONJSONWebTokenAuth
QUERY PARAMETERS

 

List<String>
files 
List<String> cvlds
String
orgid                        (required)
String username               (required)
String
userId                     (required)
String orgtype                   (required)
String sessionId                (required)
String
orgBaseURL          (required)
String
mergedFileName (required)
String
sequence                (required)

Responses

400 - Bad Request
Message :

  • Bad request (User friendly message about wrong request body)
  • Request should atleast contain two PDF’s.
401 - Unauthorized
Message :

  • Unauthorized : Your org is not registered to use this service.
  • Unauthorized : Your are not a registered user to use this service.
403 - Forbidden
Message :

  • Forbidden: User is inactive.
413 - Payload Too Large
Message :

  • File size is too large
500 - Internal Server Error
Message :

  • Files merge failed. Please contact admin.
Server - https://napp.eruditeworks.com/ API Endpoint - /api/merge-pdfs
 

   Request Samples (Payload)

 

{  
files: [ "VE9PTUFOWVNFQ1JFVFM=", "LK0PTUFOWGBFQ1JFHFM=" ],  
cvIds: ["0689D000001Z78qQAC", "0689D000001FG8qQAC"], 
orgid: "00D7i000000VHHfLkd", 
username: "SALESFORCE_USER_NAME", 
userId: "SALESFORCE_USER_ID", 
orgtype: "PRODUCTION", 
sessionId: "dsdsoipfskjjdfshiud******", 
orgBaseURL: "SALESFORCE_ORG_BASEURL",  
mergedFileName: myfile,  
sequence: [file0, cvFile0, file1, cvFile1]
}

 

 

   Response Samples

 

 


{
"id": 24382,
"name": "Invoice template",
"owner": true,
"created_at": "2022-01-21 11:49:28",
"updated_at": "2022-08-01 23:49:28",
   "tags":  [
                     "invoice",
                      "orders"
                 ]
}/