Description
Allows user to login to the website via a remote location. This method can only be called from a browser.
URL
All responses are in JSON format by default, to specify an XML response add ".xml" to the end of the method name (in this case "login"). Note: This method only produces a response if the "customize" parameter is passed.
https://<yoursubdomain>.filetransfers.net/api/login
Restrictions
The calling user must have:
- A valid username or password on this site.
Parameters
Bold indicates required. Please note this method does not require an API Key, timestamp or signature.
| Parameter | Description |
|---|---|
| username_login | Username of the user logging in to your site. |
| password_login | Password of the user logging in to your site. |
| customize | Default is 0. If set to 1 the logged-in URL will be returned, but the user will not automatically be taken to that location. Also, any error messages will also be returned so that they can be customized on the calling website. |
Sample Response
If the "customize" is passed, a response will be returned.
Successful response In JSON:
{"loginLocation": "<yoursubdomain>.filetransfers.netfileList.php"}
Successful response in XML:
<loginLocation><yoursubdomain>.filetransfers.netfileList.php</loginLocation>
Error response In JSON:
{"error":{"title":"Please enter a username in order to login.",
"message":"If you do not have a username please speak to an administrator"}}
Error response In XML:
<error> <title>Please enter a username in order to login.</title> <message>If you do not have a username please speak to an administrator</message> </error>
