Oversigt
API’er om den aktuelle status i spilverdenen er altid sjove, så TTR har offentliggjort vores interne invasionstracker til verden via et API, der kan bruges offentligt.
Designet for dette API er drevet af implementeringen af den faktiske invasionssporing på TTR-servere. Hvert distrikt sender periodisk aktuelle invasionsdata til en central server (denne server er dog ikke vores webserver), hvor de gemmes i hukommelsen. På en separat timer forespørger TTR-weblaget med jævne mellemrum denne centrale server om de seneste invasionsdata, som derefter lagres i cachen og returneres til alle, der forespørger på invasions-API’en. Dette design er fleksibelt og kræver kun få ekstra ressourcer for at fungere, selv om dataene ikke er så friske som følge heraf.
Bemærk: Overskriften Access-Control-Allow-Origin er indstillet til * på dette API.
Anmodninger
En HTTP GET til invasions-API-slutpunktet, https://www.toontownrewritten.com/api/invasions, returnerer det seneste JSON-svar. Der kræves ingen parametre, men hvis du ofte foretager opkald til dette API, vil jeg dog sætte pris på, at du indstiller en beskrivende User-Agent.
Response
| Name | Details |
|---|---|
| error | Når der er data til stede, vil error blive sat til nul. Hvis error ikke er null, vil der ikke være andre felter til stede, og error vil blive sat til en fejlmeddelelse |
| invasions | En ordbog med distriktnavne til invasionsdata. |
| lastUpdated | Epoketidsstempel for, hvornår weblaget sidst har spurgt efter data. |
Invasion data
| Name | Details |
|---|---|
| type | Navnet på den invaderende kotelet. Det lokaliserede navn vil altid være på engelsk og vil altid være cog’ens entalform. Hvis cog’en er en skelecog, vil (Skelecog) blive tilføjet. Hvis koggen er version 2.0, vil Version 2.0 blive tilføjet. |
| asOf | Epoke-tidsstempel for, hvornår distriktet sidst rapporterede sin invasionsstatus. |
| fremskridt | En streng af formen %d/%d, hvor det første tal repræsenterer antallet af kogs, der allerede er despawnet under invasionen, og det andet tal repræsenterer den samlede størrelse af invasionen. |