Important!
This documentation has been deprecated. We are migrating Oempro help articles to our new help portal. Take a look at more detailed help articles on our new help portal.
Sections:
- Description
- Oempro Version
- Request Parameters
- Response Parameters
- Error Codes
User.Login
Description
Verifies the provided username and password then logs the user in.
Oempro Version
4+
Request Parameters
- Command = {User.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: http: //en.wikipedia.org/wiki/JSON#JSONP
- Username = {string} (required)
- Username of the user to be logged in
- Password = {string} (required)
- Password of the user to be logged in
- RememberMe = {string} (required)
- If set to any value, login information will be saved in the cookie and login will be skipped next time
- 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
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!