THE API BASICS
System Administration API
Description: System configuration processes. Requires administrator to be signed in.
Default URL: https://your-site.com/api/admin/sys
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/sys",
data : {
req : "get-cfg",
user_email : [0,1]
}
}).done(
// DO YOUR PROCESSING HERE
);
GET
req: get-cfg
Description: Get configuration
Parameters
[INT/ARRAY] $_POST[‘config_group’] – A single group ID or array of group IDs.
req: get-cfg-key
Description: Get config by key(s)
Parameters
[STRING] $_POST[‘config_key’] – A single config key or array of config keys.
SETTINGS
req: set-cfg
Description: Save system config settings
Parameters
[ARRAY] $_POST[‘config’] – An array of [CONFIG KEY => CONFIG VALUE]