THE API BASICS
User API
Description: Basic user processes.
Default URL: https://your-site.com/api/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/user",
data : {
req : "forgot",
user_email : "john@doe.com"
}
}).done(
// DO YOUR PROCESSING HERE
);
SESSION
req: login
Description: Sign in
Parameters
[STRING] $_POST[‘user_email’] – Email
[STRING] $_POST[‘user_password’] – Password
[STRING] $_POST[‘user_password’] – Password
req: logoff
Description: Sign off
Parameters
None.
ADMINISTRATION
req: reg
Description: Register new account
Parameters
Must not be signed in
[STRING] $_POST[‘user_name’] – Name
[STRING] $_POST[‘user_email’] – Email
[STRING] $_POST[‘user_password’] – Password
[STRING] $_POST[‘confirm_password’] – Confirm Password
[STRING] $_POST[‘redirect’] – (optional) Redirect to this slug on successful user activation
[STRING] $_POST[‘user_name’] – Name
[STRING] $_POST[‘user_email’] – Email
[STRING] $_POST[‘user_password’] – Password
[STRING] $_POST[‘confirm_password’] – Confirm Password
[STRING] $_POST[‘redirect’] – (optional) Redirect to this slug on successful user activation
req: update
Description: update user account
Parameters
Must be signed in
[STRING] $_POST[‘user_name’] – Name
[STRING] $_POST[‘user_email’] – Email
[STRING] $_POST[‘user_password’] – (Optional) Password
[STRING] $_POST[‘confirm_password’] – (Optional) Confirm Password
[STRING] $_POST[‘user_name’] – Name
[STRING] $_POST[‘user_email’] – Email
[STRING] $_POST[‘user_password’] – (Optional) Password
[STRING] $_POST[‘confirm_password’] – (Optional) Confirm Password
req: forgot
Description: Forgot password – Send reset link to user email.
Parameters
Must not be signed in
[STRING] $_POST[‘user_email’] – User email
[STRING] $_POST[‘user_email’] – User email
