REST APIs

IDriveSync EVS REST APIs: Development now made easy!

Account configuration

To protect your account with the highest level of security, IDriveSync EVS configures your account with military standard encryption. This is done by using the configureAccount API.

Quick links

Syntax for ‘configureAccount’ API:

https://<server address>/evs/configureAccount

Server address:
Use
getServerAddress API to retrieve the IDriveSync server address.

HTTP method: POST
Input parameters:
uid username or email address
pwd password
enctype=<default> or <private> The value of 'enctype' parameter can be either 'default' or 'private', based on the encryption option that you wish to set for your IDriveSync account.Set to either 'Default encryption key' or 'Private encryption key' for your account based on your encryption requirement.

If the 'enctype' value is set to 'private' then the 'pvtkey' parameter is a must, otherwise it is not required.
pvtkey Private encryption key is an optional parameter and is not required if you would like to set default encryption key for your IDriveSync account. Private encryption key length can vary from minimum of 4 characters to maximum of 255 characters.


If you are using OAuth authentication method, uid and pwd are not required.

Output:
Below is a sample XML output generated during account configuration:
<tree message="SUCCESS" desc="YOUR ACCOUNT IS CONFIGURED SUCCESSFULLY"/>

Description:
  • tree
    Root node with attributes; message and desc.
  • message
    This attribute describes the operation as SUCCESS or FAIL.
  • desc
    This attribute holds the description of the SUCCESS or FAIL case.

Following cases explain the expected outputs during INVALID operations:
  • Case 1: Empty Username or Password
    <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: If the account encryption configuration does not match.

    The output is as follows:
    <tree message="ERROR" desc="YOUR ACCOUNT IS ALREADY CONFIGURED"/>

Code snippets for Java, PHP, Python and Ruby:
Java:

PHP:

Python:

Ruby:

Refer web browser design screenshots to design the browser based account configuration page using this API.