ToontownRewritten / api-doc

Przegląd

API dotyczące aktualnego statusu świata gry są zawsze zabawne, więc TTR opublikowało nasz wewnętrzny tracker inwazji dla świata poprzez publicznie konsumowalne API.

Projekt tego API jest napędzany przez implementację rzeczywistego śledzenia inwazji na serwerach TTR. Każdy dystrykt okresowo wysyła aktualne dane o inwazji do centralnego serwera (choć ten serwer nie jest naszym serwerem internetowym), gdzie są one przechowywane w pamięci. W osobnym timerze, warstwa WWW TTR okresowo odpytuje ten centralny serwer o najnowsze dane o inwazjach, które są następnie buforowane i zwracane każdemu, kto zapyta API o inwazje. Ten projekt jest elastyczny i wymaga niewielu dodatkowych zasobów do działania, choć dane nie są w rezultacie tak świeże.

Uwaga: Nagłówek Access-Control-Allow-Origin jest ustawiony na * w tym API.

Żądania

Przez HTTP GET do punktu końcowego API inwazji, https://www.toontownrewritten.com/api/invasions, zostanie zwrócona najnowsza odpowiedź JSON. Nie są wymagane żadne parametry, jednak jeśli często wykonujesz połączenia z tym API, będę wdzięczny, jeśli ustawisz opisowy User-Agent.

Response

Name Details
error Gdy dane są obecne, error zostanie ustawione na null. Jeśli error nie jest null, to żadne inne pola nie będą obecne, a error zostanie ustawione na komunikat o błędzie
inwazje Słownik nazw dzielnic do danych inwazji.
lastUpdated Znacznik czasowy epoki, w której warstwa sieciowa po raz ostatni zapytała o dane.

Dane inwazji

Name Details
type Nazwa trybika inwazyjnego. Zlokalizowana nazwa zawsze będzie w języku angielskim i zawsze będzie formą liczby pojedynczej. Jeśli trybik jest skelecogiem, zostanie dodane (Skelecog). Jeśli trybik jest w wersji 2.0, zostanie dodane Version 2.0 .
asOf Znacznik czasu epoki, w której dzielnica ostatnio zgłosiła swój status inwazji.
progress Ciąg znaków, w postaci %d/%d, gdzie pierwsza liczba reprezentuje liczbę trybików już zdesperowanych podczas inwazji, a druga liczba reprezentuje całkowity rozmiar inwazji.

.

Dodaj komentarz

Twój adres e-mail nie zostanie opublikowany.