API Service Documentation

Command: validate_user

Returns status message to Client based on user credentials.

Commandline Example: curl --data "ai_login_id=api_user&ai_login_password=IhN4hth1IwlL&ai_command=validate_user&username=test9999&password=test9999" https://example.com/service

Request

NameTypeRequiredExample
usernameStringYjohndoe

The username of the customer (alphanumeric and dashes). This cannot be left blank.

passwordStringYPass123

The password must contain at least 7 characters and include at least one uppercase letter, one lower case letter, and one number

Response

NameTypeExample
validationString'success'

validation may be 'success', 'fail', 'error'

user_idInteger1001

In case of successful match, returns user_id of authenticated username.
@example commandline