SonicPanel Knowledgebase

Available PHP/JSON API for Developers

The following examples are simple API calls for the SonicPanel software. You can use the API to develop your own custom automation for SonicPanel or billing modules and systems including client management. We tried to keep the example codes as simple as possible for everyone.

Requirements & Limits:

You need your API key to make calls. You can simply get your own API key from the Root SonicPanel >> Billing & Automation(API) link on the left menu. Copy your API key to use it with the following API calls.
The brute force protection is enabled by default on API calls, sending invalid API key 5 times will get your website/source server IP blocked for 1 hour. You may disable the brute force protection service from the Root SonicPanel >> Service Manager on the left menu during the development to prevent unwanted blocks. Remember to enable the brute force service when going for production.

Available API Calls/Actions

packs
create
changepass
change
terminate
suspend
unsuspend

API Calls are simple curl calls and the API returns JSON output from the server as a result.

Action Packs:

Lists available radio/account packages by comma that are created on SonicPanel root and the packs required to be used on radio creations. Create some packages from the SonicPanel Root >> Add a Package link on the left menu. You can use the package names on create function to create a radio later on. You may save the packages on your own database for future usage or call the packs action to retrive them whenever needed.

PHP Example:

<?php // Packs API call returns direct string without JSON format, result is seperated by comma, so you can explode it easily for foreach loop. // Required Data $domain = 'domain.com'; // SonicPanel Server Domain $serveruser = 'root'; // The user root or the reseller username $api_key = 'PKWRURTP48SGK2QYQA6Q'; // The API key $sonicpanel_server = "https://$domain:2087/api/sonic_api.php"; $data = [ 'cmd' => "packs", // The API Action 'owner' => "$serveruser", 'key' => "$api_key", ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $sonicpanel_server); $retval = curl_exec($ch); $getresponse = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_error($ch)) {echo $server_ip . ' - ' . curl_errno($ch) . ' - ' . curl_error($ch); exit;} curl_close($ch); if ($getresponse == 401) {echo "SonicPanel Server Invalid API Key! Check your username and API Key(Password) in your billing software server settings for this active server $server_ip. Multiple login failures in 1 hour will get your website IP banned for 1 hour."; exit;} if ($getresponse == 500) {echo "Multiple API Login Failures Detected: Your website IP is blocked for 1 hour to login. Read the limits and security in SonicPanel under the Billing and API page"; exit;} echo $retval; // list of packages that are created on sonicpanel root. ?>

Action Create:

Create a radio with the package name from the sonicpanel server easily. You can also list packages on a form to allow user to select on order form or send the package name from your script, make sure to send the package name exactly to API. For example shoutcast50 or unlimitedsc named packages are listed on the SP server root panel >> edit/list packages link from the left menu can be used. This call also returns radio port information, see the example below.

PHP Example:

<?php // Required Data $domain = "domain.com"; // SonicPanel Server Domain $serveruser = "root"; // The user root or the reseller username $api_key = "PKWRURTP48SGK2QYQA6Q"; // The API key $package = "shoutcast50"; // Exact package name from the sonicpanel server root panel >> List/edit Packages page. $radiousername = "sptest5"; // The username for the account and it must be unique, you may use the client name with random numbers or filter email before @ to use. $client_email = "test@example.com"; // The client email, the user will recevie an email from the SonicPanel, you may edit your email templates on sonicpanel root. // Random Clear Password for user login, will be encrypted on the server side automatically. $chars = "ABCDEFGHJKMNPQRSTUVWXYZ23456789";srand((double)microtime()*1000000);$i = 0;$pass = '' ;while ($i <= 20) {$num = rand() % 45;$tmp = substr($chars, $num, 1);$pass = $pass . $tmp;$i++;} // Random Clear Password for user login, will be encrypted on the server side automatically. $sonicpanel_server = "https://$domain:2087/api/sonic_api.php"; $data = [ 'cmd' => "create", // The API Action 'owner' => "$serveruser", 'key' => "$api_key", 'package' => "$package", 'rad_username' => "$radiousername", 'client_email' => "$client_email", 'panel_pass' => "$pass", 'send_email' => "yes", // SonicPanel will send welcome email, yes or no ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $sonicpanel_server); $retval = curl_exec($ch); $getresponse = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_error($ch)) {echo $server_ip . ' - ' . curl_errno($ch) . ' - ' . curl_error($ch); exit;} curl_close($ch); if ($getresponse == 401) {echo "SonicPanel Server Invalid API Key! Check your username and API Key(Password) in your billing software server settings for this active server $server_ip. Multiple login failures in 1 hour will get your website IP banned for 1 hour."; exit;} if ($getresponse == 500) {echo "Multiple API Login Failures Detected: Your website IP is blocked for 1 hour to login. Read the limits and security in SonicPanel under the Billing and API page"; exit;} $obj = json_decode($retval); $return = $obj->{'result'}; // Always return as complete if the radio is created or returns the reason of failure. $port = $obj->{'port'}; // The created radio standart port number on the server, you can use for anything. $adminpass = $obj->{'radminpass'}; // The admin password of the radio $panelusername = $obj->{'username'}; // The username of the radio if ($return=='complete') { // Radio successfully created on the SP server, do things here. } else { // Failed to create the radio, see the reason. echo $return; exit; } ?>

Action ChangePasss:

Change existed SonicPanel user login password on the server.

PHP Example:

<?php // Required Data $domain = "domain.com"; // SonicPanel Server Domain $serveruser = "root"; // The user root or the reseller username $api_key = "PKWRURTP48SGK2QYQA6Q"; // The API key $radiousername = "sptest5"; // The existed username on the sonicpanel server to change the login password. $new_password = "123456sptest"; $sonicpanel_server = "https://$domain:2087/api/sonic_api.php"; $data = [ 'cmd' => "changepass", // The API Action 'owner' => "$serveruser", 'key' => "$api_key", 'rad_username' => "$radiousername", 'password' => "$new_password", ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $sonicpanel_server); $retval = curl_exec($ch); $getresponse = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_error($ch)) {echo $server_ip . ' - ' . curl_errno($ch) . ' - ' . curl_error($ch); exit;} curl_close($ch); if ($getresponse == 401) {echo "SonicPanel Server Invalid API Key! Check your username and API Key(Password) in your billing software server settings for this active server $server_ip. Multiple login failures in 1 hour will get your website IP banned for 1 hour."; exit;} if ($getresponse == 500) {echo "Multiple API Login Failures Detected: Your website IP is blocked for 1 hour to login. Read the limits and security in SonicPanel under the Billing and API page"; exit;} $obj = json_decode($retval); $return = $obj->{'result'}; // Always return as complete or returns the reason of failure. if ($return=='complete') { // Password changed. Do things here } else { // Failed, see the reason. echo $return; exit; } ?>

Action Change:

Change existed SonicPanel user radio package/plan. Useful for upgrade/downgrade or changing radio systems.

PHP Example:

<?php // Required Data $domain = "domain.com"; // SonicPanel Server Domain $serveruser = "root"; // The user root or the reseller username $api_key = "PKWRURTP48SGK2QYQA6Q"; // The API key $radiousername = "sptest5"; // The existed username on the sonicpanel server $new_pack = "newshoutcast100"; // The new package name to assign user, packages are SonicPanel Root >> List/Edit Packages from the left menu or use API packs function for user interaction on orders etc.. $sonicpanel_server = "https://$domain:2087/api/sonic_api.php"; $data = [ 'cmd' => "change", // The API Action 'owner' => "$serveruser", 'key' => "$api_key", 'rad_username' => "$radiousername", 'pack' => "$new_pack", ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $sonicpanel_server); $retval = curl_exec($ch); $getresponse = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_error($ch)) {echo $server_ip . ' - ' . curl_errno($ch) . ' - ' . curl_error($ch); exit;} curl_close($ch); if ($getresponse == 401) {echo "SonicPanel Server Invalid API Key! Check your username and API Key(Password) in your billing software server settings for this active server $server_ip. Multiple login failures in 1 hour will get your website IP banned for 1 hour."; exit;} if ($getresponse == 500) {echo "Multiple API Login Failures Detected: Your website IP is blocked for 1 hour to login. Read the limits and security in SonicPanel under the Billing and API page"; exit;} $obj = json_decode($retval); $return = $obj->{'result'}; // Always return as complete or returns the reason of failure. if ($return=='complete') { // Success. Do things here } else { // Failed, see the reason. echo $return; exit; } ?>

Action Terminate:

Terminate/Delete user and the radio from the SonicPanel server.

PHP Example:

<?php // Required Data $domain = "domain.com"; // SonicPanel Server Domain $serveruser = "root"; // The user root or the reseller username $api_key = "PKWRURTP48SGK2QYQA6Q"; // The API key $radiousername = "sptest5"; // The existed username on the sonicpanel server. $sonicpanel_server = "https://$domain:2087/api/sonic_api.php"; $data = [ 'cmd' => "terminate", // The API Action 'owner' => "$serveruser", 'key' => "$api_key", 'rad_username' => "$radiousername", ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $sonicpanel_server); $retval = curl_exec($ch); $getresponse = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_error($ch)) {echo $server_ip . ' - ' . curl_errno($ch) . ' - ' . curl_error($ch); exit;} curl_close($ch); if ($getresponse == 401) {echo "SonicPanel Server Invalid API Key! Check your username and API Key(Password) in your billing software server settings for this active server $server_ip. Multiple login failures in 1 hour will get your website IP banned for 1 hour."; exit;} if ($getresponse == 500) {echo "Multiple API Login Failures Detected: Your website IP is blocked for 1 hour to login. Read the limits and security in SonicPanel under the Billing and API page"; exit;} $obj = json_decode($retval); $return = $obj->{'result'}; // Always return as complete or returns the reason of failure. if ($return=='complete') { // Success. Do things here } else { // Failed, see the reason. echo $return; exit; } ?>

Action Suspend:

Suspend user and the radio on the SonicPanel server.

PHP Example:

<?php // Required Data $domain = "domain.com"; // SonicPanel Server Domain $serveruser = "root"; // The user root or the reseller username $api_key = "PKWRURTP48SGK2QYQA6Q"; // The API key $radiousername = "sptest5"; // The existed username on the sonicpanel server. $sonicpanel_server = "https://$domain:2087/api/sonic_api.php"; $data = [ 'cmd' => "suspend", // The API Action 'owner' => "$serveruser", 'key' => "$api_key", 'rad_username' => "$radiousername", ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $sonicpanel_server); $retval = curl_exec($ch); $getresponse = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_error($ch)) {echo $server_ip . ' - ' . curl_errno($ch) . ' - ' . curl_error($ch); exit;} curl_close($ch); if ($getresponse == 401) {echo "SonicPanel Server Invalid API Key! Check your username and API Key(Password) in your billing software server settings for this active server $server_ip. Multiple login failures in 1 hour will get your website IP banned for 1 hour."; exit;} if ($getresponse == 500) {echo "Multiple API Login Failures Detected: Your website IP is blocked for 1 hour to login. Read the limits and security in SonicPanel under the Billing and API page"; exit;} $obj = json_decode($retval); $return = $obj->{'result'}; // Always return as complete or returns the reason of failure. if ($return=='complete') { // Success. Do things here } else { // Failed, see the reason. echo $return; exit; } ?>

Action UnSuspend:

UnSuspend user and the radio on the SonicPanel server.

PHP Example:

<?php // Required Data $domain = "domain.com"; // SonicPanel Server Domain $serveruser = "root"; // The user root or the reseller username $api_key = "PKWRURTP48SGK2QYQA6Q"; // The API key $radiousername = "sptest5"; // The existed username on the sonicpanel server. $sonicpanel_server = "https://$domain:2087/api/sonic_api.php"; $data = [ 'cmd' => "unsuspend", // The API Action 'owner' => "$serveruser", 'key' => "$api_key", 'rad_username' => "$radiousername", ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0); curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0); curl_setopt($ch, CURLOPT_POST, 1); curl_setopt($ch, CURLOPT_POSTFIELDS, $data); curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); curl_setopt($ch, CURLOPT_TIMEOUT, 30); curl_setopt($ch, CURLOPT_URL, $sonicpanel_server); $retval = curl_exec($ch); $getresponse = curl_getinfo($ch, CURLINFO_HTTP_CODE); if (curl_error($ch)) {echo $server_ip . ' - ' . curl_errno($ch) . ' - ' . curl_error($ch); exit;} curl_close($ch); if ($getresponse == 401) {echo "SonicPanel Server Invalid API Key! Check your username and API Key(Password) in your billing software server settings for this active server $server_ip. Multiple login failures in 1 hour will get your website IP banned for 1 hour."; exit;} if ($getresponse == 500) {echo "Multiple API Login Failures Detected: Your website IP is blocked for 1 hour to login. Read the limits and security in SonicPanel under the Billing and API page"; exit;} $obj = json_decode($retval); $return = $obj->{'result'}; // Always return as complete or returns the reason of failure. if ($return=='complete') { // Success. Do things here } else { // Failed, see the reason. echo $return; exit; } ?>

SonicPanel Documentation

Available PHP/JSON API for Developers