Overzicht
API’s over de huidige status van de spelwereld zijn altijd leuk, dus heeft TTR onze interne invasie tracker gepubliceerd aan de wereld via een publiekelijk te gebruiken API.
Het ontwerp voor deze API wordt gedreven door de implementatie van daadwerkelijke invasie tracking op TTR servers. Elk district stuurt periodiek actuele invasiegegevens naar een centrale server (hoewel die server niet onze webserver is), waar ze in het geheugen worden opgeslagen. Op een aparte timer vraagt de TTR weblaag periodiek aan deze centrale server om de laatste invasiegegevens, die dan in de cache worden opgeslagen en worden teruggestuurd naar iedereen die de invasie-API opvraagt. Dit ontwerp is flexibel en vereist weinig extra middelen om te werken, hoewel de gegevens daardoor niet zo vers zijn.
Note: De header Access-Control-Allow-Origin is ingesteld op * bij deze API.
Requests
Een HTTP GET naar het invasies API eindpunt, https://www.toontownrewritten.com/api/invasions, zal de meest recente JSON respons teruggeven. Er zijn geen parameters nodig, echter, als je vaak oproepen doet naar deze API, zou ik het op prijs stellen als je een beschrijvende User-Agent instelt.
Response
| Name | Details |
|---|---|
| error | Wanneer er gegevens aanwezig zijn, wordt error op null gezet. Als error niet null is, dan zullen geen andere velden aanwezig zijn, en error zal op een foutmelding worden gezet |
| invasies | Een woordenboek van districtnamen aan invasiegegevens. |
| lastUpdated | De epoch-tijdstempel van wanneer de weblaag voor het laatst om gegevens is gevraagd. |
Invasiegegevens
| Naam | Details |
|---|---|
| type | De naam van het binnenvallende radertje. De gelokaliseerde naam is altijd in het Engels, en is altijd de enkelvoudsvorm van het radertje. Als de rader een skelecog is, zal (Skelecog) worden toegevoegd. Als het radertje versie 2.0 is, wordt Version 2.0 toegevoegd. |
| asOf | De tijdstempel van het tijdstip waarop het district voor het laatst zijn invasiestatus heeft gerapporteerd. |
| voortgang | Een string, van de vorm %d/%d, waarbij het eerste getal staat voor het aantal koggen dat tijdens de invasie reeds is verjaagd en het tweede getal voor de totale omvang van de invasie. |