API Guide: Authentication
All API commands require prior authentication. To authenticate use the auth
command. Once authenticated the session is valid till the user is logged out or session times out.
| Parameter | Notes |
|---|---|
| c | always set to auth
|
| name | The user's name. |
| pass | The password. |
| logout | Logout and close the session, valid only if already logged in and the session is valid.
If this parameter is used, the name and password values are irrelevant and ignored.
|
https://<install_path>/api.php?c=auth&user=name&pass=xxx
You will receive a response like
{
"status":"notok",
"user":"",
"group":"",
"error":"Invalid name or password (1\/6)"
}
or
{
"status":"ok",
"user":"setup",
"group":"setupadmin",
"error":"",
"userid":0,
"admin":1,
"url":"https:\/\/local.codepunch.com\/dev\/wmdsed4\/"
}