Difference between revisions of "AWBS API"
(→USAGE INSTRUCTIONS) |
(→Available Commands) |
||
| Line 1: | Line 1: | ||
== Available Commands == | == Available Commands == | ||
| − | + | ===adduser=== | |
| − | + | ===addhosting=== | |
| − | + | ===adddomain=== | |
| − | + | ===suspendhosting=== | |
| + | ===unsuspendhosting=== | ||
| + | ===cancelhosting=== | ||
| + | ===addhostingpackage=== | ||
| + | ===addhostingserver=== | ||
| + | ===resetpassword=== | ||
| + | ===checkserverstats=== | ||
Note: checkserverstats will return a list of open/pending items separated by a pipe (|) character. | Note: checkserverstats will return a list of open/pending items separated by a pipe (|) character. | ||
helpdesk|others|reminders|contact_form|package_queue|users | helpdesk|others|reminders|contact_form|package_queue|users | ||
| − | + | ===checkapi=== | |
| + | ===addinvoice=== | ||
| + | ===getcart=== | ||
| + | ===checkdomain=== | ||
| + | ===getuser=== | ||
| + | ===payinvoice=== | ||
| + | ===updatecc=== | ||
| + | ===verifyuser=== | ||
| + | |||
== Usage Instructions == | == Usage Instructions == | ||
Revision as of 09:11, April 1, 2010
Contents
- 1 Available Commands
- 1.1 adduser
- 1.2 addhosting
- 1.3 adddomain
- 1.4 suspendhosting
- 1.5 unsuspendhosting
- 1.6 cancelhosting
- 1.7 addhostingpackage
- 1.8 addhostingserver
- 1.9 resetpassword
- 1.10 checkserverstats
- 1.11 checkapi
- 1.12 addinvoice
- 1.13 getcart
- 1.14 checkdomain
- 1.15 getuser
- 1.16 payinvoice
- 1.17 updatecc
- 1.18 verifyuser
- 2 Usage Instructions
- 3 Return and Options
Available Commands
adduser
addhosting
adddomain
suspendhosting
unsuspendhosting
cancelhosting
addhostingpackage
addhostingserver
resetpassword
checkserverstats
Note: checkserverstats will return a list of open/pending items separated by a pipe (|) character. helpdesk|others|reminders|contact_form|package_queue|users
checkapi
addinvoice
getcart
checkdomain
getuser
payinvoice
updatecc
verifyuser
Usage Instructions
- Edit your Extended System Config and allow API access from your IP in the remote_list field. Note: Each allowed IP is separated by a | (pipe)
- Set your Private Key in AWBS System Setup/System Options.
The API currently accepts HTTP POST only.
Sample cURL Post
$data="command=adduser&help=1&accesskey=mykey"; $ch = curl_init(); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, "$data"); curl_setopt($ch, CURLOPT_URL, "https://www.yoursite.com/interface.php"); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_TIMEOUT, 15); $ret = curl_exec($ch); curl_close($ch);
Note: You can alternatively send: &maccesskey=[md5 encoded key as shown on the System Config page] if you wish to not send the key in plain text
Return and Options
Posting help=1 will get you help on the function sent in the command.
When not sending help=1, you will receive either a "SUCCESS" response, or if the call failed, you will receive an "ERROR,error description" response.
You can also send the &altout=1 command. This will cause the api to return the insert_id for sql injections instead of the usual SUCCESS. Sending &checkapi=1 will return SUCCESS if you validate on the api (and pass ip check).
