Sections:

1. Description
2. Oempro Version
3. Request Parameters
4. Response Parameters
5. Error Codes

Admin.Login

Description

Verifies and logs in the admin account.

Oempro Version

Oempro v4.0 and higher versions

Request Parameters

Command = {Admin.Login} (required)

API Command

ResponseFormat = {JSON | XML} (required)

Response format

JSONPCallBack = {bool}

Send this parameter for cross-domain. More info about JSONP can be found here

Username = {string} (required)

Username of the client to be logged in

Password = {string} (required)

Password of the client to be logged in

RememberMe = {string} (required)

Stores the login information in the cookie

Captcha = {string} (required)

If captcha image verification is enabled, direct API login will be disabled

DisableCaptcha = {true | false} (optional)

If this parameter is passed in, it will by-pass the captcha validation

Response Parameters

Success = {true | false}

States if there is an error or not

ErrorCode = {integer}

If there is an error, error's code

SessionID = {string}

SessionID of the logged in user

AdminInfo = {array}

Provided if the login information is correct. Contains the logged in administrator account information

Error Codes

1

Username is missing

2

Password is missing

3

Invalid login information

4

Invalid image verification

5

Image verification failed

99998

Authentication failure or session expired

99999

Not enough privileges

Stay connected!