THE API BASICS
User Administration API
Description: System configuration processes. Requires administrator to be signed in.
Default URL: https://your-site.com/api/admin/user
Response/return: Cart Boxx APIs will always return a standard response, most data will be put into the “cb-more” response field – Check out function verbose in the library reference.
Example Usage
$.ajax({
url : "https://your-site.com/api/admin/user",
data : {
req : "get",
user_id : 999
}
}).done(
// DO YOUR PROCESSING HERE
);
GET
req: count
Description: Get a count of all users (for pagination use)
Parameters
[STRING] $_POST[‘search’] – (optional) Search for this user name/email
req: get-all
Description: Get all users
Parameters
[STRING] $_POST[‘search’] – (optional) Search for this user name/email
[INT] $_POST[‘page’] – (optional) Current page number.
[INT] $_POST[‘page’] – (optional) Current page number.
req: get
Description: Get user by ID
Parameters
[INT] $_POST[‘user_id’] – User ID
req: get-email
Description: Get user by email
Parameters
[STRING] $_POST[‘user_email’] – User email
ADMINISTRATION
req: add
Description: Add new user
Parameters
[STRING] $_POST[‘user_name’] – User name
[STRING] $_POST[‘user_email’] – User email
[STRING] $_POST[‘user_password’] – User password
[STRING] $_POST[‘confirm_password’] – Confirm password
[STRING] $_POST[‘user_active’] – User account status
[STRING] $_POST[‘user_level’] – User account level
[STRING] $_POST[‘user_email’] – User email
[STRING] $_POST[‘user_password’] – User password
[STRING] $_POST[‘confirm_password’] – Confirm password
[STRING] $_POST[‘user_active’] – User account status
[STRING] $_POST[‘user_level’] – User account level
req: update
Description: Update user
Parameters
[INT] $_POST[‘user_id’] – User ID
[STRING] $_POST[‘user_name’] – User name
[STRING] $_POST[‘user_email’] – User email
[STRING] $_POST[‘user_password’] – (Optional) User password
[STRING] $_POST[‘confirm_password’] – (Optional) Confirm password
[STRING] $_POST[‘user_active’] – User account status
[STRING] $_POST[‘user_level’] – User account level
[STRING] $_POST[‘user_name’] – User name
[STRING] $_POST[‘user_email’] – User email
[STRING] $_POST[‘user_password’] – (Optional) User password
[STRING] $_POST[‘confirm_password’] – (Optional) Confirm password
[STRING] $_POST[‘user_active’] – User account status
[STRING] $_POST[‘user_level’] – User account level
req: suspend
Description: Suspend user
Parameters
[INT] $_POST[‘user_id’] – User ID
req: activate
Description: Activate user
Parameters
[INT] $_POST[‘user_id’] – User ID
req: del
Description: Delete user
Parameters
[INT] $_POST[‘user_id’] – User ID
