Winsurtech File Junction API Documentation

Request Method: POST 

Endpoint: {{BaseUrl}}/api/login

Description:

Users have to provide their email address and password in the stated parameters. Upon entering the correct details, an access token would be generated. The users are required to enter the generated token in the 'Token' variable in the Postman collection. 

Input Parameters: 

Parameters Required (in the API): 

1. email: Users are required to provide their registered email address.

2. password: Users are required to provide a valid password.

Postman Screenshot:

Once the user logs in, the other endpoints can be used. 

Request Method:  GET

Endpoint:  {{BaseUrl}}/my-connections-list

Description:

This endpoint furnishes the details of all connections of the user. The connection's name, type, CIN, WXID, official email, state, and city of the users are present in the generated output.

Postman Screenshot:

Request Method:  POST

Endpoint:  {{BaseUrl}}/send-connection-request

Description:

As the name specifies, this endpoint enables the users to send a connection request to a specific user, present on the platform. Users have to enter the official target-CIN and target-WXID of the user to connect. 

Input Parameters:

Parameters Required (in the API): 

1. target-CIN: Users are required to provide the CIN of the requested user.

2. target-WXID: Users are required to provide the WXID of the requested user.

Postman Screenshot:

Request Method:  PUT

Endpoint:  {{BaseUrl}}/accept-connection-request

Description:

This endpoint permits the users to accept the connection requests received. Users have to enter the request sender's sender-CIN and sender-WXID.

Input Parameters:  

Parameters Required (in the API) : 

1. sender-CIN: Users are required to enter the CIN of the sender of the request. 

2. sender-WXID: Users are required to enter the WXID of the sender of the request. 

Postman Screenshot:

Request Method:  GET

Endpoint:  {{BaseUrl}}/connection-requests-received

Description:

This endpoint presents to the users the connection requests received. Details like Sender's name, email, organization name, type, branch name, CIN, and WXID are accessible in the generated output. 

Postman Screenshot:

Request Method:  PUT

Endpoint:  {{BaseUrl}} /remove-connection

Description:

Users can remove the optional connections, through this endpoint. Users are directed to enter the optional connection's target-CIN and target-WXID, to remove the connection.

Input Parameters:

Parameters Required (in the API): 

1. target-CIN: Users are required to provide the CIN of the connection they wish to remove. 

2. target-WXID: Users are required to provide the WXID of the connection they wish to remove.

Postman Screenshot:

Request Method:  POST

Endpoint:  {{BaseUrl}}/upload-file

Description:

Intending to upload a new file users, ought to use this endpoint. Users must provide a zip file in the 'input-file' parameter and the type of file they are providing. Users can choose the file type among AL3, eDoc, Claim, DBCD, Graphic, Text Document, and Other. 

Although there can be multiple files in a single zip file that the user wishes to upload. But the users cannot upload multiple zip files at once. 

Input Parameters: 

Parameters Required (in the API): 

1. input-file: Users need to provide the zip file they wish to share.

2. file-type: Users are required to provide one of the file types among AL3, eDoc, Claim, DBCD, Graphic, Text Document, and Other.

3. extract: This parameter enables the users to upload their zip files, extracted if passed 'Yes'. Otherwise, the file will get uploaded in a zipped format. 

Postman Screenshot:

Request Method:  POST

Endpoint:  {{BaseUrl}}/send-files-to-mailbox

Description:

This endpoint enables the users to upload and send the file to a particular connection. Users are required to provide the target-CIN and target-WXID of the required connection along with a zip file in the input-file parameter and the type of file among AL3, eDoc, Claim, DBCD, Graphic, Text Document, and Other in the file type parameter.

Input Parameter 

Parameters Required (in the API):  

1. target-CIN: Provide the CIN of the connection you wish to send the file.

2. target-WXID: Provide the WXID of the connection you wish to send the file.

3. input-file: Users are required to provide the zip file they wish to share with the particular connection.

4. file-type: Users are required to provide one of the file types among AL3, eDoc, Claim, DBCD, Graphic, Text Document, and Other.

5. extract: This parameter enables the users to upload and send their zip files, to the required connections, extracted if passed 'Yes'. Otherwise, the file will get uploaded and sent to the desired connections in a zipped format.  

   Postman Screenshot:

Request Method:  GET

Endpoint:  {{BaseUrl}}/files-sent-to-a-mailbox

Description:

Details of all the files sent by a user to a particular connection are provided by this endpoint. Users are required to provide details like the receiver-CIN and receiver-WXID of the receiver along with the from-date and to-date of the file sent.

Input Parameters: 

Parameters Required (in the API): 

1. receiver-CIN: Enter the CIN of the preferred users whose details you wish to fetch.

2. receiver-WXID: Enter the WXID of the preferred users whose details you wish to fetch.

3. from-date: Users need to enter the date from which they wish to fetch the details.

4. to-date: Users need to enter the date till which they wish to fetch the details.

  Postman Screenshot:

Request Method:  GET

Endpoint:  {{BaseUrl}}/received-file-information

Description:

This endpoint enables the users to fetch details of all files received by a user excluding already downloaded files. Users have to provide the from-date and to-date of the period, within which, the file is shared. To include already downloaded files, users need to enter the value as true for parameter included_already_downloaded.

Input Parameters: 

Parameters Required (in the API):

1.  from-date: Users need to enter the date from which they wish to fetch the details.

2.  to-date: Users need to enter the date till which they wish to fetch the details.

3.  included_already_downloaded: Users need to enter the value as 'true' to include already downloaded files.

Postman Screenshot:

Request Method:  PUT

Endpoint:  {{BaseUrl}}/archive-file

Description:

To keep the data sorted or for any other reason, the users can archive the inessential documents by taking aid from this endpoint. This endpoint allows the users to archive the file if a user wishes to do so. Users must provide the file GUID of the file they are willing to archive.

Input Parameters: 

Parameters Required (in the API):

1. file-guid: Users need to enter the file guid of the file they wish to send to the archive.

Postman Screenshot:

Request Method:  POST

Endpoint:  {{BaseUrl}}/download-file

Description:

Users can download their documents with the help of this endpoint. They have to provide the file id only, in the parameter named file-GUID, which will generate the output in an encrypted format. Users are required to download the generated output with a .zip extension. 

Input Parameters:

Parameters Required (in the API): 

1. file-guid: Users need to enter the file guid of the file they wish to download.

Postman Screenshot:

Request Method:  PUT

Endpoint:  {{BaseUrl}}/unshare-file

Description:

This endpoint enables the users to unshare a file with a particular connection if they wish to. Users need to provide the target-CIN and target-WXID of the required connection, along with the file-GUID of the document they wish to unshare.

Input Parameters:

Parameters Required (in the API): 

1. target-CIN: Users must enter the CIN of the user with whom they wish to unshare the file. 

2. target-WXID: Users must enter the WXID of the user with whom they wish to unshare the file. 

3. file-guid: Users need to enter the file guid of the file they wish to unshare.

Postman Screenshot:

Request Method:  POST

Endpoint:  {{BaseUrl}}/share-files

Description:

Users can share a new document, an uploaded document, or an unshared document in case they wish to share it again with a specific connection. Users are required to provide the target-CIN and target-WXID of the desired user along with file-guid of the document or file they wish to share.

Input Parameters: 

Parameters Required (in the API): 

1. target-CIN: Users are required to enter the CIN of the user with whom they wish to share the file.

2. target-WXID: Users are required to enter the WXID of the user with whom they wish to share the file.

3. file-guid: Users need to enter the file guid of the file they wish to share.

Postman Screenshot: