Create Template API
Introduction
Efficiency meets versatility with our cutting-edge API. Seamlessly upload template files in docx, editable pdf, and html formats, along with JSON data defining variables. Experience the convenience of generating tailored contracts effortlessly, then save it with a unique template ID. This ID becomes your passport to streamlined contract creation, as you create customized contracts and more. Join us on a journey to redefine contract management and witness the power of the Create Template API in action. Your path to efficient, personalized contracts starts here.
Authentication
API authentication is a crucial security process that ensures authorized access to an application programming interface (API). It involves validating the identity of users or systems seeking to interact with the API. Please use the access token shared with you by your assigned Signzy's CSM. Please set the value of the key Authorization in the headers to the access token, while making an API call. In this way, Signzy's system will be able to authenticate you and you will be able to make a successful API call.
API Details
The details of the API can be found here.
Sample cURL
curl --location --request POST 'https://api-preproduction.signzy.app/api/v3/template/save' \
--header 'Authorization: *****************************' \
--header 'Content-Type: application/json' \
--data '{
"templateName": "name of template",
"templateType": "docx, html, editablePdf",
"templateData": "url or base64",
"templateRequiredVariables": "json data keys to be filled in template in desired format"
}'Input Parameters
Key | Description | Type | Mandatory /Optional |
|---|---|---|---|
templateName | Name of the template | String | Mandatory |
templateType | Type of the template The 3 supported types are -
| String | Mandatory |
templateData | URL or base64 data of the template | String | Mandatory |
templateRequiredVariables | JSON data keys to be filled in the template in desired format | String | Mandatory |
Sample Response
{
"status": "success",
"statusDesp": "Template save successfully",
"templateId": "64dc69a43a7ff2504d1c21e4"
}Output Parameters
Key | Description | Type |
|---|---|---|
status | Indicates the status of the operation | String |
statusDesp | Description of the status | String |
templateId | Id of the template. It can be used in further processes. | String |
Sample Errors
{
"name": "error",
"message": "Invalid URL extension",
"reason": "VALIDATION_ERROR",
"type": "Bad Request",
"statusCode": 400
}Error Parameter
Parameter | Type | Description |
|---|---|---|
name | String | In case of errors, it will have the value "error". It represents an error. |
message | String | Message for the error |
reason | String | Reasons for the error |
type | String | Type of error |
statusCode | String | Status code of the error |
Error Codes
Error Code | Error Message | Explanation |
|---|---|---|
400 | Bad Request | Input parameter has a missing required parameter or invalid inputs |
401 | Authorization Failed | Authorization token is invalid |
500 | Internal Server Error | Internal error at Signzy, Please reach out to [email protected] |