ToontownRewritten / api-doc

Übersicht

APIs über den aktuellen Status der Spielwelt sind immer lustig, deshalb hat TTR unseren internen Invasions-Tracker über eine öffentlich konsumierbare API veröffentlicht.

Das Design für diese API wurde durch die Implementierung der tatsächlichen Invasionsverfolgung auf den TTR-Servern bestimmt. Jeder Distrikt sendet regelmäßig aktuelle Invasionsdaten an einen zentralen Server (bei dem es sich allerdings nicht um unseren Webserver handelt), wo sie im Speicher abgelegt werden. Mit einem separaten Zeitgeber fragt die TTR-Webschicht regelmäßig diesen zentralen Server nach den neuesten Invasionsdaten ab, die dann zwischengespeichert und an jeden zurückgegeben werden, der die Invasions-API abfragt. Dieses Design ist flexibel und erfordert nur wenige zusätzliche Ressourcen für den Betrieb, obwohl die Daten dadurch nicht so frisch sind.

Hinweis: Der Header Access-Control-Allow-Origin ist bei dieser API auf * gesetzt.

Requests

Ein HTTP GET zum Invasions-API-Endpunkt, https://www.toontownrewritten.com/api/invasions, liefert die neueste JSON-Antwort. Es sind keine Parameter erforderlich, aber wenn Sie diese API häufig aufrufen, wäre es nett, wenn Sie einen aussagekräftigen User-Agent festlegen.

Antwort

Name Details
Fehler Wenn Daten vorhanden sind, wird error auf Null gesetzt. Wenn error nicht null ist, sind keine anderen Felder vorhanden, und error wird auf eine Fehlermeldung gesetzt
Invasionen Ein Wörterbuch mit Bezirksnamen zu Invasionsdaten.
lastUpdated Der Epochenzeitstempel, wann die Webebene zuletzt Daten abgefragt hat.

Invasionsdaten

Name Details
Typ Der Name des eindringenden Zahnrads. Der lokalisierte Name ist immer in englischer Sprache und ist immer die Singularform der Kogge. Handelt es sich bei dem Zahnrad um ein Skelecog, wird (Skelecog) angehängt. Handelt es sich um einen Cog der Version 2.0, wird Version 2.0 vorangestellt.
asOf Der Zeitstempel der Epoche, in der der Bezirk zuletzt seinen Invasionsstatus gemeldet hat.
Fortschritt Eine Zeichenkette der Form %d/%d, wobei die erste Zahl die Anzahl der während der Invasion bereits despawnten Koggen und die zweite Zahl die Gesamtgröße der Invasion darstellt.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht.