Getting Started

Table of Contents Getting started with the TCAdmin PHP SDK Important Notes Before Beginning Installing TCAdmin-php-sdk Initializing the TCAdmin class

Getting started with the TCAdmin PHP SDK

Important Notes Before Beginning

1. TCAdmin is a very old server management suite but it is still maintained and new games & voice services are being added to its supported list all the time. The actual API being utilized here relies on the Billing API that comes standard with the TCAdmin installation.
2. When using TCAdmin it is best to install TCAdmin using a remote database or a database you can communicate with via your applications (i.e. web site, scripts, etc...). Most of the useful information that TCAdmin has such as server IP:Port is only available by pulling this information from the actual tables TCAdmin uses to store all the server data. Linking tables is dependent on your system setup. This is covered a bit more in the [Adding-Servers] section.
3. Note that TCAdmin has allowed very limited functionality when communicating with the TCAdmin master server via the Billing API. The Billing API functionality currently only includes: (Version Implemented)
   1. Adding Servers - Version 1.0+
   2. Suspend/Unsuspend Servers - Version 1.0+
   3. Upgrade Servers - Version 1.0+
   4. Deleting Servers - Version 1.0+
   5. Listing Servers - Not implemented
   6. Change User Password - Not implemented

Installing TCAdmin-php-sdk

This class is super easy to install. Just drop the tcadmin.php file wherever you load your classes from and include it using your bootstrap loader or require_once().

Initializing the TCAdmin class

First thing we need to do is init the actual class. TCAdmin PHP SDK uses a static factory to create the class instance as you need it so the connection information is stored as a static property of the class so you only have to set the setting once. Also any of the settings (properties) can be changed on the fly as needed.

Set the connection string. This gives the class the information to actually send cURL requests to your TCAdmin master server. TCAdmin::$api_connect_string = 'http://APIUsername:[email protected]/path/to/billingapi.aspx');

Now we should set the full base path to the actual GUI side of the TCAdmin Master Server. This will allows you to make links to the master server on the fly so the users can edit their server configs, map lists, run updates, install mods, etc... We will show how this is done later. TCAdmin::$root_url = 'http://yourdomain.com/path/to/Templates/Default/';

Now we can fire up the instance to do calls with the Master TCAdmin server. See [Adding-Servers]