@extends('admin.layouts.app') @section('title', __('admin.api_docs.title')) @section('content')
{!! __('admin.api_docs.auth_intro') !!}
| {{ __('admin.api_docs.parameter') }} | {{ __('common.table.description') }} |
|---|---|
identifier | {{ __('admin.api_docs.identifier_desc') }} |
secret | {{ __('admin.api_docs.secret_desc') }} |
action | {!! __('admin.api_docs.action_param_desc') !!} |
{{ __('admin.api_docs.base_url') }}: POST {{ url('/api/v1') }}
{!! __('admin.api_docs.response_note') !!}
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getstats | {{ __('admin.api_docs.desc_getstats') }} | |
| POST | gethealthstatus | {{ __('admin.api_docs.desc_gethealthstatus') }} | |
| POST | pnlcsdetails | {{ __('admin.api_docs.desc_pnlcsdetails') }} | |
| POST | sendadminemail | {{ __('admin.api_docs.desc_sendadminemail') }} | subject, message |
| POST | addannouncement | {{ __('admin.api_docs.desc_addannouncement') }} | title, announcement, published |
| POST | getannouncements | {{ __('admin.api_docs.desc_getannouncements') }} | limitnum, limitstart |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getclients | {{ __('admin.api_docs.desc_getclients') }} | search, limitnum, limitstart, sorting, orderby |
| POST | getclientsdetails | {{ __('admin.api_docs.desc_getclientsdetails') }} | clientid or email (required) |
| POST | addclient | {{ __('admin.api_docs.desc_addclient') }} | firstname, lastname, email, password, address1, city, country, phonenumber |
| POST | updateclient | {{ __('admin.api_docs.desc_updateclient') }} | clientid (required), any client field |
| POST | deleteclient | {{ __('admin.api_docs.desc_deleteclient') }} | clientid (required) |
| POST | getclientpassword | {{ __('admin.api_docs.desc_getclientpassword') }} | clientid (required) |
| POST | updateclientpassword | {{ __('admin.api_docs.desc_updateclientpassword') }} | clientid, password (required) |
| POST | validatelogin | {{ __('admin.api_docs.desc_validatelogin') }} | email, password (required) |
| POST | getclientgroups | {{ __('admin.api_docs.desc_getclientgroups') }} | |
| POST | addclientnote | {{ __('admin.api_docs.desc_addclientnote') }} | userid, note (required) |
| POST | getclientnotes | {{ __('admin.api_docs.desc_getclientnotes') }} | userid (required) |
| POST | getclientsaddons | {{ __('admin.api_docs.desc_getclientsaddons') }} | clientid (required) |
| POST | getcontacts | {{ __('admin.api_docs.desc_getcontacts') }} | userid (required) |
| POST | addcontact | {{ __('admin.api_docs.desc_addcontact') }} | clientid, email, firstname, lastname (required) |
| POST | updatecontact | {{ __('admin.api_docs.desc_updatecontact') }} | contactid (required) |
| POST | deletecontact | {{ __('admin.api_docs.desc_deletecontact') }} | contactid (required) |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getinvoices | {{ __('admin.api_docs.desc_getinvoices') }} | userid, status, limitnum, limitstart |
| POST | getinvoice | {{ __('admin.api_docs.desc_getinvoice') }} | invoiceid (required) |
| POST | createinvoice | {{ __('admin.api_docs.desc_createinvoice') }} | userid, date, duedate, itemdescription[], itemamount[], paymentmethod |
| POST | updateinvoice | {{ __('admin.api_docs.desc_updateinvoice') }} | invoiceid (required), status, date, duedate |
| POST | addinvoicepayment | {{ __('admin.api_docs.desc_addinvoicepayment') }} | invoiceid, transid, gateway, date, amount (required) |
| POST | captureinvoice | {{ __('admin.api_docs.desc_captureinvoice') }} | invoiceid (required) |
| POST | sendinvoice | {{ __('admin.api_docs.desc_sendinvoice') }} | invoiceid (required) |
| POST | deleteinvoice | {{ __('admin.api_docs.desc_deleteinvoice') }} | invoiceid (required) |
| POST | getinvoiceitemtypes | {{ __('admin.api_docs.desc_getinvoiceitemtypes') }} |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getorders | {{ __('admin.api_docs.desc_getorders') }} | userid, status, limitnum, limitstart |
| POST | getorderstatuses | {{ __('admin.api_docs.desc_getorderstatuses') }} | |
| POST | addorder | {{ __('admin.api_docs.desc_addorder') }} | clientid, pid[], billingcycle[], paymentmethod (required) |
| POST | acceptorder | {{ __('admin.api_docs.desc_acceptorder') }} | orderid (required) |
| POST | pendingorder | {{ __('admin.api_docs.desc_pendingorder') }} | orderid (required) |
| POST | cancelorder | {{ __('admin.api_docs.desc_cancelorder') }} | orderid (required) |
| POST | fraudorder | {{ __('admin.api_docs.desc_fraudorder') }} | orderid (required) |
| POST | deleteorder | {{ __('admin.api_docs.desc_deleteorder') }} | orderid (required) |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | gettickets | {{ __('admin.api_docs.desc_gettickets') }} | clientid, deptid, status, limitnum, limitstart |
| POST | getticket | {{ __('admin.api_docs.desc_getticket') }} | ticketid (required) |
| POST | openticket | {{ __('admin.api_docs.desc_openticket') }} | deptid, clientid, subject, message (required) |
| POST | addticketreply | {{ __('admin.api_docs.desc_addticketreply') }} | ticketid, message (required), adminid or clientid |
| POST | updateticket | {{ __('admin.api_docs.desc_updateticket') }} | ticketid (required), status, subject, deptid |
| POST | deleteticket | {{ __('admin.api_docs.desc_deleteticket') }} | ticketid (required) |
| POST | deleteticketreply | {{ __('admin.api_docs.desc_deleteticketreply') }} | ticketid, replyid (required) |
| POST | getsupportdepartments | {{ __('admin.api_docs.desc_getsupportdepartments') }} | ignore_dept_assignments |
| POST | getsupportstatuses | {{ __('admin.api_docs.desc_getsupportstatuses') }} | deptid |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getclientsdomains | {{ __('admin.api_docs.desc_getclientsdomains') }} | clientid (required), limitnum, limitstart |
| POST | getdomains | {{ __('admin.api_docs.desc_getdomains') }} | limitnum, limitstart, domain |
| POST | domainwhois | {{ __('admin.api_docs.desc_domainwhois') }} | domain (required) |
| POST | domainregister | {{ __('admin.api_docs.desc_domainregister') }} | domainid (required) |
| POST | domainrenew | {{ __('admin.api_docs.desc_domainrenew') }} | domainid (required) |
| POST | domaintransfer | {{ __('admin.api_docs.desc_domaintransfer') }} | domainid (required) |
| POST | domainrelease | {{ __('admin.api_docs.desc_domainrelease') }} | domainid, newtag (required) |
| POST | domainsync | {{ __('admin.api_docs.desc_domainsync') }} | domainid (required) |
| POST | domainupdatelockstatus | {{ __('admin.api_docs.desc_domainupdatelockstatus') }} | domainid, lockstatus (required) |
| POST | getregistrars | {{ __('admin.api_docs.desc_getregistrars') }} | |
| POST | gettldpricing | {{ __('admin.api_docs.desc_gettldpricing') }} | currencyid |
| POST | updatedomain | {{ __('admin.api_docs.desc_updatedomain') }} | domainid (required), expirydate, status, registrar, regdate |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getclientsproducts | {{ __('admin.api_docs.desc_getclientsproducts') }} | clientid (required), limitnum, limitstart, pid, serviceid |
| POST | getproducts | {{ __('admin.api_docs.desc_getproducts') }} | pid, gid, module |
| POST | addservice | {{ __('admin.api_docs.desc_addservice') }} | clientid, pid, paymentmethod (required) |
| POST | updateclientproduct | {{ __('admin.api_docs.desc_updateclientproduct') }} | serviceid (required), any service field |
| POST | modulecreate | {{ __('admin.api_docs.desc_modulecreate') }} | serviceid (required) |
| POST | moduleterminate | {{ __('admin.api_docs.desc_moduleterminate') }} | serviceid (required) |
| POST | modulesuspend | {{ __('admin.api_docs.desc_modulesuspend') }} | serviceid (required) |
| POST | moduleunsuspend | {{ __('admin.api_docs.desc_moduleunsuspend') }} | serviceid (required) |
| POST | modulechangepackage | {{ __('admin.api_docs.desc_modulechangepackage') }} | serviceid (required) |
| POST | modulechangepassword | {{ __('admin.api_docs.desc_modulechangepassword') }} | serviceid (required) |
| POST | modulenotifyexpiry | {{ __('admin.api_docs.desc_modulenotifyexpiry') }} | serviceid (required) |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getquotes | {{ __('admin.api_docs.desc_getquotes') }} | userid, status, limitnum, limitstart |
| POST | createquote | {{ __('admin.api_docs.desc_createquote') }} | userid, subject, validuntil, lineitems (required) |
| POST | updatequote | {{ __('admin.api_docs.desc_updatequote') }} | quoteid (required) |
| POST | deletequote | {{ __('admin.api_docs.desc_deletequote') }} | quoteid (required) |
| POST | sendquote | {{ __('admin.api_docs.desc_sendquote') }} | quoteid (required) |
| POST | acceptquote | {{ __('admin.api_docs.desc_acceptquote') }} | quoteid (required) |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getprojects | {{ __('admin.api_docs.desc_getprojects') }} | limitnum, limitstart |
| POST | getproject | {{ __('admin.api_docs.desc_getproject') }} | projectid (required) |
| POST | createproject | {{ __('admin.api_docs.desc_createproject') }} | title, adminid, clientid, status (required) |
| POST | updateproject | {{ __('admin.api_docs.desc_updateproject') }} | projectid (required) |
| POST | deleteproject | {{ __('admin.api_docs.desc_deleteproject') }} | projectid (required) |
| POST | addprojecttask | {{ __('admin.api_docs.desc_addprojecttask') }} | projectid, title (required) |
| POST | updateprojecttask | {{ __('admin.api_docs.desc_updateprojecttask') }} | projectid, taskid (required) |
| POST | deleteprojecttask | {{ __('admin.api_docs.desc_deleteprojecttask') }} | projectid, taskid (required) |
| POST | addprojectmessage | {{ __('admin.api_docs.desc_addprojectmessage') }} | projectid, message, adminid (required) |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | gettransactions | {{ __('admin.api_docs.desc_gettransactions') }} | clientid, invoiceid, limitnum, limitstart |
| POST | addtransaction | {{ __('admin.api_docs.desc_addtransaction') }} | clientid, invoiceid, description, amountin, amountout, gateway, date (required) |
| POST | getcurrencies | {{ __('admin.api_docs.desc_getcurrencies') }} | |
| POST | addcredit | {{ __('admin.api_docs.desc_addcredit') }} | clientid, description, amount (required) |
| POST | applycredit | {{ __('admin.api_docs.desc_applycredit') }} | clientid, invoiceid, amount (required) |
| POST | addpaymentmethod | {{ __('admin.api_docs.desc_addpaymentmethod') }} | clientid, gateway, card_last_four, card_expiry (required) |
| POST | deletepaymentmethod | {{ __('admin.api_docs.desc_deletepaymentmethod') }} | clientid, card_id (required) |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | addproduct | {{ __('admin.api_docs.desc_addproduct') }} | name, gid, type, paytype (required) |
| POST | updateproduct | {{ __('admin.api_docs.desc_updateproduct') }} | pid (required), any product field |
| POST | deleteproduct | {{ __('admin.api_docs.desc_deleteproduct') }} | pid (required) |
| POST | getproductgroups | {{ __('admin.api_docs.desc_getproductgroups') }} |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | sendemail | {{ __('admin.api_docs.desc_sendemail') }} | messagename, id (clientid/serviceid/invoiceid depending on template) |
| POST | sendclientsmail | {{ __('admin.api_docs.desc_sendclientsmail') }} | clientid, subject, message (required) |
| POST | getemailtemplate | {{ __('admin.api_docs.desc_getemailtemplate') }} | name (required) |
| {{ __('admin.api_docs.method') }} | {{ __('admin.api_docs.action') }} | {{ __('common.table.description') }} | {{ __('admin.api_docs.key_params') }} |
|---|---|---|---|
| POST | getadmins | {{ __('admin.api_docs.desc_getadmins') }} | |
| POST | getadmindetails | {{ __('admin.api_docs.desc_getadmindetails') }} | |
| POST | addadmin | {{ __('admin.api_docs.desc_addadmin') }} | username, firstname, lastname, email, password, roleid (required) |
| POST | updateadmin | {{ __('admin.api_docs.desc_updateadmin') }} | adminid (required), any field |
| POST | deleteadmin | {{ __('admin.api_docs.desc_deleteadmin') }} | adminid (required) |
| POST | getadminroles | {{ __('admin.api_docs.desc_getadminroles') }} |
curl -X POST {{ url('/api/v1') }} \
-d "identifier=YOUR_IDENTIFIER" \
-d "secret=YOUR_SECRET" \
-d "action=getclients" \
-d "limitnum=25"
<?php
$url = '{{ url('/api/v1') }}';
$params = [
'identifier' => 'YOUR_IDENTIFIER',
'secret' => 'YOUR_SECRET',
'action' => 'getclients',
'limitnum' => 25,
];
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($params));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
print_r($result);
import requests
url = '{{ url('/api/v1') }}'
payload = {
'identifier': 'YOUR_IDENTIFIER',
'secret': 'YOUR_SECRET',
'action': 'getclients',
'limitnum': 25,
}
response = requests.post(url, data=payload)
print(response.json())
curl -X POST {{ url('/api/v1') }} \
-d "identifier=YOUR_IDENTIFIER" \
-d "secret=YOUR_SECRET" \
-d "action=createinvoice" \
-d "userid=1" \
-d "date=2026-01-01" \
-d "duedate=2026-01-15" \
-d "itemdescription[]=Hosting - January 2026" \
-d "itemamount[]=29.99" \
-d "paymentmethod=banktransfer"
<?php
$params = [
'identifier' => 'YOUR_IDENTIFIER',
'secret' => 'YOUR_SECRET',
'action' => 'createinvoice',
'userid' => 1,
'date' => '2026-01-01',
'duedate' => '2026-01-15',
'itemdescription' => ['Hosting - January 2026'],
'itemamount' => [29.99],
'paymentmethod' => 'banktransfer',
];
// ... send POST request ...
{
"result": "success", {{ __('admin.api_docs.response_success_comment') }}
"totalresults": 25, {{ __('admin.api_docs.response_total_comment') }}
"startnumber": 0, {{ __('admin.api_docs.response_start_comment') }}
"numreturned": 10, {{ __('admin.api_docs.response_num_comment') }}
"clients": { {{ __('admin.api_docs.response_data_comment') }}
"client": [ ... ]
}
}
{{ __('admin.api_docs.response_error_comment') }}
{
"result": "error",
"message": "Authentication Failed"
}