API Documentation

User.Login

User.Login

Logs a user in and creates a user session. Sessions expire after 5 minutes unless another call is made using the returned session key.

Parameters and required information

Here's a list of all the parameters you'll need to pass to the User.Login method. All of the parameters are required unless otherwise noted.

ApiKey
Your API application key. Click here for information on where to get this key.
Username
The username of the MediaSilo user account
Password
The password of the MediaSilo user account
Hostname
The MediaSilo hostname (i.e. myaccount.mediasilo.com)

Return Codes

Success

Status: success
Logon was successful. Response will contain a valid session key.
Status: fail
The call was not successful. Most likely because the XML that was received was not correctly formatted.

Error

101: The USERNAME attribute is required in the USER_LOGON function
The USERNAME was not passed along and authentication failed.
102: The PASSWORD attribute is required in the USER_LOGON function
The PASSWORD was not passed along and authentication failed
103: The HOSTNAME attribute is required in the USER_LOGON function
The HOSTNAME was not passed along and authentication failed.
104: The APIKEY attribute is required in the USER_LOGON function
A valid API key is required but was not passed along.

HTTP POST

<?xml version="1.0" encoding="utf-8"?>  
<request>  
	<username>string</username> 
	<password>string</password>  
	<hostname>string</hostname>  
	<apikey><![CDATA[string]]></apikey>  
</request>  
 
<?xml version="1.0" encoding="utf-8"?>
	<mediasilo_response method="User.Login" status="success">
	<sessionkey>string</sessionkey>
</mediasilo_response>