Related links
Developer Resources
Download
Download your data securely from the IDrive account using the
downloadFile API.
Quick links
Syntax for ‘downloadFile’ API:
https://<server address>/evs/downloadFile
Server address:
Use getServerAddress API to retrieve the IDrive server address.
HTTP method: POST
- Input parameters:
-
uid |
username or email address |
pwd |
password |
pvtkey |
private encryption key is an optional parameter
and is not required if you opt for the default encryption
key during your IDrive account sign up |
p |
file path that you wish to download from your account. |
version |
specify the version number of the file that you wish to download |
thumbnail_type |
S - specify to download thumbnail in small size
I - specify to download thumbnail in Intermediate size
|
trash |
set trash parameter to "yes” to download files from trash
|
- Following cases explain the expected outputs during INVALID operations:
-
- Case 1: Empty Username or Password
The output is as follows:
<tree message="ERROR" desc="INVALID PARAMETERS"/>
- Case 2: Invalid Username or Password
The output is as follows:
<tree message="ERROR" desc="INVALID USER"/> Or
<tree message="ERROR" desc="INVALID PASSWORD"/>
- Case 3: Invalid path
The output is as follows:
<tree message="ERROR" desc="INVALID PATH"/>
- Case 4: Account not configured
Encryption configuration is a must for the IDrive account. If the configuration is not done for an account, the output is as follows:
<tree message="ERROR" desc="ACCOUNT NOT YET CONFIGURED" configstatus="NOT SET"/>
- Case 5: Authentication failed
If the account encryption configuration does not match, the output is as follows:
<tree message="ERROR" desc="AUTHENTICATION FAILED" />
- Code snippets for Java, PHP, Python and Ruby:
-
Java:
PHP:
Python:
Ruby: