/api/auth
Usage
Authenticates against the ARDI server to allow elevated function execution.
Note that you must call this function before calling any other ARDI function other than /api/connect when the server is not in guest mode.
Details
| Detail | Value |
|---|---|
| Group | Server |
| From Server Version | 0.9.0 |
| Permission | Public |
| Methods | GET or POST |
Parameters
| Parameter | Notes | Meaning |
|---|---|---|
| username | The users name | |
| password | The users password | |
| format | String (xml) | Either 'xml' or 'json' |
Return Value
The return value is an XML or JSON file that returns an authcode. This code is included with all future API requests as part of Signing Your Requests.
Examples
Request
http://<servername>/s/<sitename>/api/auth?username=average&password=user
Success (XML)
<login>
<authcode>db86d3b005999c126a727f53a96415b5</authcode>
<level>admin</level>
</login>
Success (JSON)
{
"authcode":"db86d3b005999c126a727f53a96415b5",
"level":"admin"
}