Přehled
API o aktuálním stavu herního světa jsou vždy zábavné, a proto TTR zveřejnil náš interní nástroj pro sledování invazí prostřednictvím veřejně použitelného API.
Návrh tohoto API vychází z implementace skutečného sledování invazí na serverech TTR. Každý okrsek pravidelně odesílá aktuální údaje o invazi na centrální server (ačkoli tento server není naším webovým serverem), kde se ukládají do paměti. Webová vrstva TTR se na základě samostatného časovače pravidelně dotazuje tohoto centrálního serveru na nejnovější data o invazi, která jsou pak uložena v mezipaměti a vrácena všem, kdo se dotazují na rozhraní API invaze. Tato konstrukce je flexibilní a pro svůj provoz nevyžaduje mnoho dalších zdrojů, ačkoli data v důsledku toho nejsou tak čerstvá.
Poznámka: Hlavička Access-Control-Allow-Origin je u tohoto rozhraní API nastavena na *.
Požadavky
Příkaz HTTP GET na koncový bod rozhraní API invazí, https://www.toontownrewritten.com/api/invasions, vrátí nejnovější odpověď JSON. Nejsou vyžadovány žádné parametry, nicméně pokud často voláte toto rozhraní API, ocenil bych, kdybyste nastavili popisný User-Agent.
Response
| Name | Details |
|---|---|
| error | Pokud jsou data přítomna, error bude nastaveno na null. Pokud error není nulové, nebudou přítomna žádná další pole a error bude nastaveno na chybové hlášení |
| invaze | Slovník názvů okresů k údajům o invazi. |
| lastUpdated | Časové razítko epochy, kdy se webová vrstva naposledy dotazovala na data. |
Údaje o invazi
| Název | Podrobnosti |
|---|---|
| typ | Název invazního ozubeného kola. Lokalizovaný název bude vždy v angličtině a vždy se bude jednat o jednotný tvar ozubeného kola. Pokud je cog skelecog, bude připojeno (Skelecog). Pokud je cog verze 2.0, bude doplněno Version 2.0 . |
| asOf | Časové razítko epochy, kdy okres naposledy ohlásil svůj stav invaze. |
| progress | Řetězec ve tvaru %d/%d, kde první číslo představuje počet ozubených kol, která již byla během invaze vypuštěna, a druhé číslo představuje celkovou velikost invaze. |
Podrobné informace o invazi.