Översikt
API:er om spelvärldens aktuella status är alltid roliga, så TTR har publicerat vår interna invasionsspårare till världen via ett API som kan användas av allmänheten.
Designen här API:n är driven av implementeringen av den faktiska invasionsspårningen på TTR-servrarna. Varje distrikt skickar regelbundet aktuella invasionsdata till en central server (även om den servern inte är vår webbserver), där de lagras i minnet. På en separat timer frågar TTR:s webblager regelbundet denna centrala server efter de senaste invasionsuppgifterna, som sedan lagras i cacheminnet och returneras till alla som frågar efter invasions-API:et. Denna konstruktion är flexibel och kräver få extra resurser för att fungera, även om data inte är lika färska som resultat.
Notera: Huvudet Access-Control-Allow-Origin är inställt på * på detta API.
Begäranden
En HTTP GET till slutpunkten för invasions-API:n, https://www.toontownrewritten.com/api/invasions, returnerar det senaste JSON-svaret. Inga parametrar krävs, men om du ofta ringer till det här API:et skulle jag uppskatta om du anger en beskrivande User-Agent.
Svar
| Namn | Detaljer |
|---|---|
| fel | När data finns kommer error att sättas till null. Om error inte är null kommer inga andra fält att finnas och error kommer att sättas till ett felmeddelande |
| invasions | En ordbok med distriktsnamn till invasionsdata. |
| lastUpdated | Den epoktidsstämpel som anger när webblagret senast frågade efter data. |
Invasion data
| Name | Details |
|---|---|
| type | Namnet på den invaderande kuggen. Det lokaliserade namnet kommer alltid att vara på engelska och kommer alltid att vara den singulära formen av koggen. Om kuggen är en skelecog kommer (Skelecog) att läggas till. Om koggen är version 2.0 kommer Version 2.0 att läggas till. |
| asOf | Den epokala tidsstämpeln för när distriktet senast rapporterade sin invasionsstatus. |
| progress | En sträng av formen %d/%d, där det första talet representerar antalet kuggar som redan har avspillts under invasionen och det andra talet representerar den totala storleken på invasionen. |