@extends('admin.layouts.app') @section('title', __('admin.api_docs.title')) @section('content') {{-- Authentication --}}

{{ __('admin.api_docs.auth_title') }}

{!! __('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') !!}

{{-- Table of Contents --}}

{{ __('admin.api_docs.toc') }}

{{-- SYSTEM --}}

{{ __('admin.api_docs.section_system') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetstats{{ __('admin.api_docs.desc_getstats') }}
POSTgethealthstatus{{ __('admin.api_docs.desc_gethealthstatus') }}
POSTpnlcsdetails{{ __('admin.api_docs.desc_pnlcsdetails') }}
POSTsendadminemail{{ __('admin.api_docs.desc_sendadminemail') }}subject, message
POSTaddannouncement{{ __('admin.api_docs.desc_addannouncement') }}title, announcement, published
POSTgetannouncements{{ __('admin.api_docs.desc_getannouncements') }}limitnum, limitstart
{{-- CLIENTS --}}

{{ __('admin.api_docs.section_clients') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetclients{{ __('admin.api_docs.desc_getclients') }}search, limitnum, limitstart, sorting, orderby
POSTgetclientsdetails{{ __('admin.api_docs.desc_getclientsdetails') }}clientid or email (required)
POSTaddclient{{ __('admin.api_docs.desc_addclient') }}firstname, lastname, email, password, address1, city, country, phonenumber
POSTupdateclient{{ __('admin.api_docs.desc_updateclient') }}clientid (required), any client field
POSTdeleteclient{{ __('admin.api_docs.desc_deleteclient') }}clientid (required)
POSTgetclientpassword{{ __('admin.api_docs.desc_getclientpassword') }}clientid (required)
POSTupdateclientpassword{{ __('admin.api_docs.desc_updateclientpassword') }}clientid, password (required)
POSTvalidatelogin{{ __('admin.api_docs.desc_validatelogin') }}email, password (required)
POSTgetclientgroups{{ __('admin.api_docs.desc_getclientgroups') }}
POSTaddclientnote{{ __('admin.api_docs.desc_addclientnote') }}userid, note (required)
POSTgetclientnotes{{ __('admin.api_docs.desc_getclientnotes') }}userid (required)
POSTgetclientsaddons{{ __('admin.api_docs.desc_getclientsaddons') }}clientid (required)
POSTgetcontacts{{ __('admin.api_docs.desc_getcontacts') }}userid (required)
POSTaddcontact{{ __('admin.api_docs.desc_addcontact') }}clientid, email, firstname, lastname (required)
POSTupdatecontact{{ __('admin.api_docs.desc_updatecontact') }}contactid (required)
POSTdeletecontact{{ __('admin.api_docs.desc_deletecontact') }}contactid (required)
{{-- INVOICES --}}

{{ __('admin.api_docs.section_invoices') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetinvoices{{ __('admin.api_docs.desc_getinvoices') }}userid, status, limitnum, limitstart
POSTgetinvoice{{ __('admin.api_docs.desc_getinvoice') }}invoiceid (required)
POSTcreateinvoice{{ __('admin.api_docs.desc_createinvoice') }}userid, date, duedate, itemdescription[], itemamount[], paymentmethod
POSTupdateinvoice{{ __('admin.api_docs.desc_updateinvoice') }}invoiceid (required), status, date, duedate
POSTaddinvoicepayment{{ __('admin.api_docs.desc_addinvoicepayment') }}invoiceid, transid, gateway, date, amount (required)
POSTcaptureinvoice{{ __('admin.api_docs.desc_captureinvoice') }}invoiceid (required)
POSTsendinvoice{{ __('admin.api_docs.desc_sendinvoice') }}invoiceid (required)
POSTdeleteinvoice{{ __('admin.api_docs.desc_deleteinvoice') }}invoiceid (required)
POSTgetinvoiceitemtypes{{ __('admin.api_docs.desc_getinvoiceitemtypes') }}
{{-- ORDERS --}}

{{ __('admin.api_docs.section_orders') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetorders{{ __('admin.api_docs.desc_getorders') }}userid, status, limitnum, limitstart
POSTgetorderstatuses{{ __('admin.api_docs.desc_getorderstatuses') }}
POSTaddorder{{ __('admin.api_docs.desc_addorder') }}clientid, pid[], billingcycle[], paymentmethod (required)
POSTacceptorder{{ __('admin.api_docs.desc_acceptorder') }}orderid (required)
POSTpendingorder{{ __('admin.api_docs.desc_pendingorder') }}orderid (required)
POSTcancelorder{{ __('admin.api_docs.desc_cancelorder') }}orderid (required)
POSTfraudorder{{ __('admin.api_docs.desc_fraudorder') }}orderid (required)
POSTdeleteorder{{ __('admin.api_docs.desc_deleteorder') }}orderid (required)
{{-- TICKETS --}}

{{ __('admin.api_docs.section_tickets') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgettickets{{ __('admin.api_docs.desc_gettickets') }}clientid, deptid, status, limitnum, limitstart
POSTgetticket{{ __('admin.api_docs.desc_getticket') }}ticketid (required)
POSTopenticket{{ __('admin.api_docs.desc_openticket') }}deptid, clientid, subject, message (required)
POSTaddticketreply{{ __('admin.api_docs.desc_addticketreply') }}ticketid, message (required), adminid or clientid
POSTupdateticket{{ __('admin.api_docs.desc_updateticket') }}ticketid (required), status, subject, deptid
POSTdeleteticket{{ __('admin.api_docs.desc_deleteticket') }}ticketid (required)
POSTdeleteticketreply{{ __('admin.api_docs.desc_deleteticketreply') }}ticketid, replyid (required)
POSTgetsupportdepartments{{ __('admin.api_docs.desc_getsupportdepartments') }}ignore_dept_assignments
POSTgetsupportstatuses{{ __('admin.api_docs.desc_getsupportstatuses') }}deptid
{{-- DOMAINS --}}

{{ __('admin.api_docs.section_domains') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetclientsdomains{{ __('admin.api_docs.desc_getclientsdomains') }}clientid (required), limitnum, limitstart
POSTgetdomains{{ __('admin.api_docs.desc_getdomains') }}limitnum, limitstart, domain
POSTdomainwhois{{ __('admin.api_docs.desc_domainwhois') }}domain (required)
POSTdomainregister{{ __('admin.api_docs.desc_domainregister') }}domainid (required)
POSTdomainrenew{{ __('admin.api_docs.desc_domainrenew') }}domainid (required)
POSTdomaintransfer{{ __('admin.api_docs.desc_domaintransfer') }}domainid (required)
POSTdomainrelease{{ __('admin.api_docs.desc_domainrelease') }}domainid, newtag (required)
POSTdomainsync{{ __('admin.api_docs.desc_domainsync') }}domainid (required)
POSTdomainupdatelockstatus{{ __('admin.api_docs.desc_domainupdatelockstatus') }}domainid, lockstatus (required)
POSTgetregistrars{{ __('admin.api_docs.desc_getregistrars') }}
POSTgettldpricing{{ __('admin.api_docs.desc_gettldpricing') }}currencyid
POSTupdatedomain{{ __('admin.api_docs.desc_updatedomain') }}domainid (required), expirydate, status, registrar, regdate
{{-- SERVICES --}}

{{ __('admin.api_docs.section_services') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetclientsproducts{{ __('admin.api_docs.desc_getclientsproducts') }}clientid (required), limitnum, limitstart, pid, serviceid
POSTgetproducts{{ __('admin.api_docs.desc_getproducts') }}pid, gid, module
POSTaddservice{{ __('admin.api_docs.desc_addservice') }}clientid, pid, paymentmethod (required)
POSTupdateclientproduct{{ __('admin.api_docs.desc_updateclientproduct') }}serviceid (required), any service field
POSTmodulecreate{{ __('admin.api_docs.desc_modulecreate') }}serviceid (required)
POSTmoduleterminate{{ __('admin.api_docs.desc_moduleterminate') }}serviceid (required)
POSTmodulesuspend{{ __('admin.api_docs.desc_modulesuspend') }}serviceid (required)
POSTmoduleunsuspend{{ __('admin.api_docs.desc_moduleunsuspend') }}serviceid (required)
POSTmodulechangepackage{{ __('admin.api_docs.desc_modulechangepackage') }}serviceid (required)
POSTmodulechangepassword{{ __('admin.api_docs.desc_modulechangepassword') }}serviceid (required)
POSTmodulenotifyexpiry{{ __('admin.api_docs.desc_modulenotifyexpiry') }}serviceid (required)
{{-- QUOTES --}}

{{ __('admin.api_docs.section_quotes') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetquotes{{ __('admin.api_docs.desc_getquotes') }}userid, status, limitnum, limitstart
POSTcreatequote{{ __('admin.api_docs.desc_createquote') }}userid, subject, validuntil, lineitems (required)
POSTupdatequote{{ __('admin.api_docs.desc_updatequote') }}quoteid (required)
POSTdeletequote{{ __('admin.api_docs.desc_deletequote') }}quoteid (required)
POSTsendquote{{ __('admin.api_docs.desc_sendquote') }}quoteid (required)
POSTacceptquote{{ __('admin.api_docs.desc_acceptquote') }}quoteid (required)
{{-- PROJECTS --}}

{{ __('admin.api_docs.section_projects') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetprojects{{ __('admin.api_docs.desc_getprojects') }}limitnum, limitstart
POSTgetproject{{ __('admin.api_docs.desc_getproject') }}projectid (required)
POSTcreateproject{{ __('admin.api_docs.desc_createproject') }}title, adminid, clientid, status (required)
POSTupdateproject{{ __('admin.api_docs.desc_updateproject') }}projectid (required)
POSTdeleteproject{{ __('admin.api_docs.desc_deleteproject') }}projectid (required)
POSTaddprojecttask{{ __('admin.api_docs.desc_addprojecttask') }}projectid, title (required)
POSTupdateprojecttask{{ __('admin.api_docs.desc_updateprojecttask') }}projectid, taskid (required)
POSTdeleteprojecttask{{ __('admin.api_docs.desc_deleteprojecttask') }}projectid, taskid (required)
POSTaddprojectmessage{{ __('admin.api_docs.desc_addprojectmessage') }}projectid, message, adminid (required)
{{-- BILLING --}}

{{ __('admin.api_docs.section_billing') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgettransactions{{ __('admin.api_docs.desc_gettransactions') }}clientid, invoiceid, limitnum, limitstart
POSTaddtransaction{{ __('admin.api_docs.desc_addtransaction') }}clientid, invoiceid, description, amountin, amountout, gateway, date (required)
POSTgetcurrencies{{ __('admin.api_docs.desc_getcurrencies') }}
POSTaddcredit{{ __('admin.api_docs.desc_addcredit') }}clientid, description, amount (required)
POSTapplycredit{{ __('admin.api_docs.desc_applycredit') }}clientid, invoiceid, amount (required)
POSTaddpaymentmethod{{ __('admin.api_docs.desc_addpaymentmethod') }}clientid, gateway, card_last_four, card_expiry (required)
POSTdeletepaymentmethod{{ __('admin.api_docs.desc_deletepaymentmethod') }}clientid, card_id (required)
{{-- PRODUCTS --}}

{{ __('admin.api_docs.section_products') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTaddproduct{{ __('admin.api_docs.desc_addproduct') }}name, gid, type, paytype (required)
POSTupdateproduct{{ __('admin.api_docs.desc_updateproduct') }}pid (required), any product field
POSTdeleteproduct{{ __('admin.api_docs.desc_deleteproduct') }}pid (required)
POSTgetproductgroups{{ __('admin.api_docs.desc_getproductgroups') }}
{{-- EMAILS --}}

{{ __('admin.api_docs.section_emails') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTsendemail{{ __('admin.api_docs.desc_sendemail') }}messagename, id (clientid/serviceid/invoiceid depending on template)
POSTsendclientsmail{{ __('admin.api_docs.desc_sendclientsmail') }}clientid, subject, message (required)
POSTgetemailtemplate{{ __('admin.api_docs.desc_getemailtemplate') }}name (required)
{{-- ADMINS --}}

{{ __('admin.api_docs.section_admins') }}

{{ __('admin.api_docs.method') }}{{ __('admin.api_docs.action') }}{{ __('common.table.description') }}{{ __('admin.api_docs.key_params') }}
POSTgetadmins{{ __('admin.api_docs.desc_getadmins') }}
POSTgetadmindetails{{ __('admin.api_docs.desc_getadmindetails') }}
POSTaddadmin{{ __('admin.api_docs.desc_addadmin') }}username, firstname, lastname, email, password, roleid (required)
POSTupdateadmin{{ __('admin.api_docs.desc_updateadmin') }}adminid (required), any field
POSTdeleteadmin{{ __('admin.api_docs.desc_deleteadmin') }}adminid (required)
POSTgetadminroles{{ __('admin.api_docs.desc_getadminroles') }}
{{-- CODE EXAMPLES --}}

{{ __('admin.api_docs.section_examples') }}

{{ __('admin.api_docs.example_get_clients') }}

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())

{{ __('admin.api_docs.example_create_invoice') }}

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 ...

{{ __('admin.api_docs.example_response') }}

{
  "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"
}
@push('scripts') @endpush @endsection