Áttekintés
A játékvilág aktuális állapotáról szóló API-k mindig szórakoztatóak, ezért a TTR közzétette a belső inváziókövetésünket a világ számára egy nyilvánosan használható API-n keresztül.
Az API tervezését a tényleges inváziókövetés megvalósítása vezérelte a TTR szerverein. Minden körzet rendszeresen elküldi az aktuális inváziós adatokat egy központi szerverre (bár ez a szerver nem a mi webszerverünk), ahol azokat a memóriában tárolják. Egy külön időzítőn a TTR webes rétege rendszeresen lekérdezi ezt a központi szervert a legfrissebb inváziós adatokért, amelyek aztán gyorsítótárba kerülnek, és visszakerülnek mindenkinek, aki az inváziós API-t lekérdezi. Ez a kialakítás rugalmas, és kevés extra erőforrást igényel a működéséhez, bár az adatok emiatt nem olyan frissek.
Figyelem: Az Access-Control-Allow-Origin fejléc ezen az API-n *-ra van állítva.
Requests
Egy HTTP GET az inváziós API végpontjára, https://www.toontownrewritten.com/api/invasions, a legújabb JSON-választ adja vissza. Nincs szükség paraméterekre, azonban ha gyakran hívja ezt az API-t, értékelném, ha egy leíró User-Agentet állítana be.
Response
| Name | Details |
|---|---|
| error | Ha van adat, a error nullára lesz állítva. Ha error nem null, akkor más mező nem lesz jelen, és error hibaüzenetre lesz állítva |
| invázió | Az inváziós adatokhoz tartozó körzetnevek szótára. |
| lastUpdated | Az epocha időbélyege, amikor a webréteg utoljára lekérdezte az adatokat. |
Inváziós adatok
| Name | Details |
|---|---|
| type | A behatoló fogaskerék neve. A honosított név mindig angol nyelvű lesz, és mindig a fogaskerék egyes számú alakja. Ha a fogaskerék skelecog, akkor (Skelecog) lesz hozzáfűzve. Ha a cog 2.0-s verziójú, a Version 2.0 előtagot kap. |
| asOf | Az epochális időbélyegző, amikor a körzet utoljára jelentette inváziós állapotát. |
| progress | Egy %d/%d alakú karakterlánc, ahol az első szám az invázió során már despawnolt fogaskerekek számát, a második szám pedig az invázió teljes méretét jelöli. |