Yleiskatsaus
API:t pelimaailman tämänhetkisestä tilasta ovat aina hauskoja, joten TTR on julkaissut sisäisen invaasionseurantajärjestelmämme maailmalle julkisesti käytettävän sovellusrajapinnan (API:n) välityksellä.
Tämän sovellusrajapinnan suunnittelun lähtökohtana on todellisen invaasionseurannan toteutus TTR:n palvelimilla. Kukin piiri lähettää ajoittain ajankohtaisia hyökkäystietoja keskuspalvelimelle (joka ei tosin ole verkkopalvelimemme), jossa ne tallennetaan muistiin. Erillisellä ajastimella TTR:n verkkokerros kysyy säännöllisesti tältä keskuspalvelimelta viimeisimmät hyökkäystiedot, jotka sitten tallennetaan välimuistiin ja palautetaan kaikille, jotka kysyvät hyökkäysten käyttöliittymää. Tämä rakenne on joustava ja vaatii vain vähän ylimääräisiä resursseja toimiakseen, vaikka tiedot eivät sen seurauksena olekaan yhtä tuoreita.
Huomaa: Access-Control-Allow-Origin -otsikon arvoksi on tässä API:ssa asetettu *.
Pyynnöt
HTP GET invasions API:n päätepisteeseen https://www.toontownrewritten.com/api/invasions palauttaa viimeisimmän JSON-vastauksen. Mitään parametreja ei vaadita, mutta jos kuitenkin soitat usein tähän API:hin, olisin kiitollinen, jos asettaisit kuvaavan User-Agent-tunnuksen.
Vastaus
| Nimi | Tiedot |
|---|---|
| virhe | Kun tietoja on, error asetetaan nollaksi. Jos error ei ole nolla, muita kenttiä ei ole, ja error asetetaan virheilmoitukseksi |
| invaasiot | Sanakirja piirien nimistä invaasiotietoihin. |
| lastUpdated | Aikaleima siitä, milloin verkkokerroksesta on viimeksi kysytty tietoja. |
Invasion data
| Name | Details |
|---|---|
| tyyppi | Invasiivisen kogin nimi. Lokalisoitu nimi on aina englanninkielinen, ja se on aina cogin yksikön muoto. Jos cog on skelecog, lisätään (Skelecog). Jos cog on versio 2.0, lisätään Version 2.0 . |
| asOf | Epookin aikaleima siitä, milloin piiri on viimeksi ilmoittanut hyökkäystilanteensa. |
| progress | Muotoinen merkkijono %d/%d, jossa ensimmäinen luku edustaa invaasion aikana jo despawnattujen hammasrattaiden lukumäärää ja toinen luku invaasion kokonaiskokoa. |