How to get an API Key details in AYAN PDF?

In order to use AYAN PDF apis, customer need to have two key attributes to use apis for different type of actions on documents. The key attributes are:

1. API Key – a unique alphanumeric key assigned to every customer. This is fixed key and cannot be changed or modified.
2. API token – an alphanumeric token assigned to every customer which can re-generated as when required.

User can get the API key using two ways:

1. Login into AYAN PDF Account: Customer can navigate to “AYAN PDF” home page and can click on “Login” button (on top right corner) to login in to their AYAN PDF account. Once the customer is successfully logged in, it will redirect to dashboard page of AYAN PDF account where they can get the API Key assigned to a customer.
2. Using AYAN Retrieve API Key api’s: Customer can use the AYAN PDF apis to get the API Key assigned to a customer. Once the HTTP request is made with all the required information, it will retrieve the API key in the callout response.

 

Parameter	Value	Description
Endpoint URL	https://sf.filezipo.io:3003/api/getAPIKey	The API endpoint url on which request will be sent
Method	POST	Set the Callout method as POST
Content-Type	application/json	Set “application/json” as content type for this request
Request Body (JSON)	{    “username”: “<<enter username>>”,    “password”: “<<enter password>>”, }	All the information in the JSON Body are mandatory. Each attribute represents as below: username – the username of the customer (Required) password – the password of the customer (Required)
Response with Code =1	{ “message”: “ok”, “data”: { “key”: “<<API key>>” }, “code”: 1 }	If the response “code” is 1, then it represents your request is successfully and an “API key” is returned in the response.
Response with code=0	{ “message”: “error”, “data”: { “message”: “Invalid Customer details” }, “code”: 0 }	If the response “code” is 0 with message=”error”, then it represents your request is failed due to below reason: “Invalid Customers details” – it defines that the customer information provided by the customer is wrong. Kindly try with the correct details.

An API Key is must to use any API on AYAN PDF. If you are facing any issues in generating API token or finding an api key, you can reach us at support@ayansoftwares.com.