How to create a merge Header using AYAN PDF apis?
User can retrieve details of an existing customer using two ways:
- Login via AYAN PDF: User can navigate to “AYAN PDF” page and can click a button (on top right corner) “Login” to login to an existing account for AYAN PDF. Once the login information is filled up, it will redirect user on to dashboard page of AYAN PDF account.
- Using AYAN Retrieve Customer API: User can use the retrieve customer api of AYAN PDF to retrieve the details for any existing customer of AYAN PDF. Once the request is made with all the required information, the api will return the customer details in the callout response.
| Parameter | Value | Description |
|---|---|---|
| Endpoint URL | https://sf.filezipo.io:3003/api/mergeHeader | 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 |
| Authorization | Bearer <<API Token>> | Use the API token of a customer. Customer can find the token in AYAN PDF account or they can re-generate a new token using Generate Token API. |
| Request Body (JSON) |
{ |
All the information in the JSON Body are not mandatory. Each attribute represents as below:
|
| Response with Code =1 | { “message”: “ok”, “data”: { “merge_id”: “67671”, “merge_date”: “2023-02-06T21:34:16.519Z”, “expire_at”: “2023-02-13T21:34:16.519Z”, “no_of_files”: 2, “download_link”: “”, “merge_by”: “Mohit”, “merge_file_name”: “testMergeFile”, “merge_folder_name”: “testMergeFile67671”, “email_sent_to”: “mohit.bansal@ayansoftwares.com”, “connect_used”: “”, “organisation_id”: “test101”, “merge_status”: “open”, “email_sent”: “pending”, }, “code”: 1 } |
If the response “code” is 1, then it represents your request is successfully submitted and api returns the below the parameters:
|
| Response with code=0 | { “message”: “error”, “data”: { “message”: “<<error message>>.” }, “code”: 0 } |
|
An API Key is must to use any API on AYAN PDF. If you are facing any issues in retrieve account or finding an api key, you can reach us at support@ayansoftwares.com.
