Allgemeine Informationen - TeamSpeakGG/tsgg-api-de GitHub Wiki

TeamSpeak.gg API

https://api.teamspeak.gg

Version: 1.0

Übersicht

Die TeamSpeak.gg API ermöglicht es dir die Dienste & Statistiken in deine eigenen Seiten einzubauen und dynamisch anzupassen. Unterteilt wird die API in Public & Private API. Die Public API (und die entsprechenden Endpoints) müssen via Webinterface freigeschaltet werden und können dann ohne Autorisierung genutzt werden. Dies ist praktisch um Daten der API beispielsweise via AJAX clientseitig einzubinden. Welche Daten über die Public API zugängig sind ist im Webinterface einstellbar. Die Private API erlaubt Zugriff auf Servereinstellungen, Clientdetails, XP & Punkte, zur Autorisierung wird ein API-Key (pro Nutzer) benötigt.

Die Antworten der API sind ausschließlich in JSON, leere Werte werden als solche zurückgegeben.

Rate Limit

Das Rate Limit verwendet das Token Bucket System.

Bei der Public API werden die Anfragen pro IP limitiert. Jeder Endpoint hat ein eigenes Rate Limit unabhängig der Menge an Gesamtanfragen. Bei Überschreitung des Limits wird der Zugang für die IP 30 Minuten lang gesperrt.

Bei der Private API werden die Anfragen pro API-Key und Endpoint limitiert. Dabei gibt es ein globales Limit für den gesamten Key und die individuellen Limits der Endpoints. Das globale Limit ist abhängig der Accountart, kann aber auch ohne Upgrade des Accounts auf Anfrage erhöht werden. Wird das Limit überschritten wird ein Burst-Limit abhängig der aktuellen Systemlast vergeben, sollte dies erschöpft oder nicht verfügbar sein wird ein Code 429 zurückgegeben. Sollte das Limit langfristig überschritten werden wird dein Account deaktiviert.

Stufe Req/s Req per X Sec
Basic 3 1800:600
Partner 5 3000:600
Poweruser 10 6000:600