API Dokumentation

Code: Verbindungstest (api)
Request URL: "../index.php?controller=api&action=api"
Required Parameters: $_POST["client"], $_POST["secret"]
Response: string JSON { "valid": true, "response": "access granted" }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Versionsinfo (versionsGet)
// Unterstützt ab Version 1.0.14 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=versionsGet"
Required Parameters: $_POST["client"], $_POST["secret"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Benutzerliste abrufen (usersGet)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=usersGet"
Required Parameters: $_POST["client"], $_POST["secret"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Benutzerdaten abrufen (userGet)
Request URL: "../index.php?controller=api&action=userGet"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*user-id*/
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Benutzer anhand des Usernamens finden (userFindByUsername)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=userFindByUsername"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["username"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Benutzer anhand der E-Mail Adresse finden (userFindByEmail)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=userFindByEmail"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["email"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Benutzer hinzufügen (userAdd)
Request URL: "../index.php?controller=api&action=userAdd"
Required Parameters: $_POST["client"], $_POST["secret"], Array ( $_POST["data"] => Array ( ["username"], ["group_id"], ["init_pw"], ["first_name"], ["last_name"], ["email"], ["lang"], ["fixed_virtual_servers"] => Array ( int 'INSTANCE-ID' => Array ( int 'VIRTUAL-SERVER-ID', int 'VIRTUAL-SERVER-ID', ... ) ) ) )
Response: string JSON { "valid": true, "response": "NEW USER-ID" }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Benutzer editieren (userModify)
// Unterstützt ab Version 0.0.10 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=userModify"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*user-id*/
Optional Parameters: Array ( $_POST["data"] => Array ( ["username"], ["group_id"], ["init_pw"], ["first_name"], ["last_name"], ["email"], ["lang"], ["fixed_virtual_servers"] => Array ( int 'INSTANCE-ID' => Array ( int 'VIRTUAL-SERVER-ID', int 'VIRTUAL-SERVER-ID', ... ) ) ) )
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Benutzer löschen (userDel)
Request URL: "../index.php?controller=api&action=userDel"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*user-id*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Rollenliste abrufen (rolesGet)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=rolesGet"
Required Parameters: $_POST["client"], $_POST["secret"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Rollendaten abrufen (roleGet)
Request URL: "../index.php?controller=api&action=roleGet"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*role-id*/
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Rolle anhand des Namens finden (roleFindByName)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=roleFindByName"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["name"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: TSI Rolle löschen (roleDel)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=roleDel"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*role-id*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Instanzliste abrufen (instancesGet)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=instancesGet"
Required Parameters: $_POST["client"], $_POST["secret"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Instanzdaten abrufen (instanceGet)
Request URL: "../index.php?controller=api&action=instanceGet"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Instanz anhand der IP finden (instanceFindByIp)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=instanceFindByIp"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["ip"]
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Instanz löschen (instanceDel)
// Unterstützt ab Version 0.0.3 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=instanceDel"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Liste der virtuellen Server einer Instanz abrufen (instanceGetServerList)
// Unterstützt ab Version 0.0.8 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=instanceGetServerList"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Daten eines virtuellen Servers abrufen (vServerGet)
// Unterstützt ab Version 0.0.9 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=vServerGet"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtual server id*/
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Virtuellen Server erstellen (vServerCreate)
// Unterstützt ab Version 0.0.9 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=vServerCreate"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/
Optional Parameters: $_POST["properties"] /*server properties*/
Response: string JSON { "valid": true, "response": "NEW VIRTUALSERVER-ID" }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Virtuellen Server ändern (vServerModify)
// Unterstützt ab Version 0.0.9 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=vServerModify"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/, $_POST["sid"] /*virtual server id*/
$_POST["properties"] /*server properties*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Virtuellen Server löschen (vServerDelete)
// Unterstützt ab Version 0.0.9 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=vServerDelete"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtualserver id*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Virtuellen Server starten (vServerStart)
// Unterstützt ab Version 0.0.9 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=vServerStart"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtualserver id*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Virtuellen Server stoppen (vServerStop)
// Unterstützt ab Version 0.0.9 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=vServerStop"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtualserver id*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Teamspeak Viewer abrufen (vServerViewGet)
// Unterstützt ab Version 0.0.7 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=vServerViewGet"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtualserver id*/
Optional Parameters: $_POST["flags"] = true /*Zeigt die Länderflaggen der jeweiligen Clients an*/,
$_POST["style"] = "old" /*Zeigt den Viewer im gewohnen TS3-Stil*/
$_POST["exclude_query_clients"] = false /* false: Query Clients anzeigen | true: Query Clients ausblenden
$_POST["format"] = "" /* "json": Antwort in Form einer JSON-Struktur, die der von der Planet TeamSpeak Simple REST-API (Servernodes) bereitgestellten Struktur ähnelt und vollständig mit dem Plugin jquery-ts3viewer kompatibel ist
Response: string JSON { "valid": true, "response": string JSON { DATA } }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Cronjobs abarbeiten (runCron)
// Unterstützt ab Version 1.0.5 der Erweiterung API-Schnittstelle
Request URL: "../index.php?controller=api&action=runCron"
Response: string JSON { "valid": true, "response": "MICROTIME" }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Prüfen ob Simple Bot aktiv ist (simpleBotIsRunning)
// Unterstützt ab Version 1.0.6 der Erweiterung API-Schnittstelle und nur in Verbindung mit dem Erweiterungsmodul Simple Bots
Request URL: "../index.php?controller=api&action=simpleBotIsRunning"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtualserver id*/
Response: string JSON { "valid": true, "response": "CURRENT BOT UID" }
Error: string JSON { "valid": false, "error": "MESSAGE || (BOOL) FALSE" }
Code: Simple Bot starten (simpleBotRun)
// Unterstützt ab Version 1.0.6 der Erweiterung API-Schnittstelle und nur in Verbindung mit dem Erweiterungsmodul Simple Bots
Request URL: "../index.php?controller=api&action=simpleBotRun"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtualserver id*/
Optional Parameters: $_POST["lang"] /*de_DE, en_GB*/,
$_POST["sid"] /*virtualserver id*/
Response: string JSON { "valid": true, "response": "CURRENT BOT UID" }
Error: string JSON { "valid": false, "error": "MESSAGE" }
Code: Simple Bot Stoppen (simpleBotStop)
// Unterstützt ab Version 1.0.6 der Erweiterung API-Schnittstelle und nur in Verbindung mit dem Erweiterungsmodul Simple Bots
Request URL: "../index.php?controller=api&action=simpleBotStop"
Required Parameters: $_POST["client"], $_POST["secret"], $_POST["id"] /*instance-id*/,
$_POST["sid"] /*virtualserver id*/
Response: string JSON { "valid": true }
Error: string JSON { "valid": false, "error": "MESSAGE" }

Antworten 1