ToontownRewritten / api-doc

Prezentare generală

API-urile despre starea actuală a lumii jocului sunt întotdeauna amuzante, așa că TTR a publicat trackerul nostru intern de invazie în lume prin intermediul unui API consumabil public.

Proiectarea acestui API este determinată de implementarea urmăririi invaziilor reale pe serverele TTR. Fiecare district trimite periodic date curente despre invazie către un server central (deși acel server nu este serverul nostru web), unde sunt stocate în memorie. Pe un cronometru separat, stratul web TTR interoghează periodic acest server central pentru cele mai recente date de invazie, care sunt apoi stocate în memoria cache și returnate tuturor celor care interoghează API-ul pentru invazii. Acest design este flexibil și necesită puține resurse suplimentare pentru a funcționa, deși datele nu sunt la fel de proaspete ca rezultat.

Nota: Antetul Access-Control-Allow-Origin este setat la * pe acest API.

Cereri

Un HTTP GET la punctul final al API de invazii, https://www.toontownrewritten.com/api/invasions, va returna cel mai recent răspuns JSON. Nu sunt necesari parametri, totuși, dacă efectuați frecvent apeluri către acest API, aș aprecia dacă ați seta un User-Agent descriptiv.

Răspuns

Nume Detalii
error Când sunt prezente date, error va fi setat la null. Dacă error nu este nul, atunci niciun alt câmp nu va fi prezent, iar error va fi setat la un mesaj de eroare
invazii Un dicționar de nume de districte pentru datele privind invaziile.
lastUpdated Timpul epocii la care stratul web a fost interogat ultima dată pentru date.

Date despre invazie

Nume Detalii
Tip Numele rotiței de invazie. Numele localizat va fi întotdeauna în limba engleză și va fi întotdeauna forma singulară a cog. În cazul în care cog-ul este un skelecog, se va adăuga (Skelecog). Dacă cog-ul este versiunea 2.0, se va adăuga Version 2.0 .
asOf Timpul epocii în care districtul a raportat ultima dată starea sa de invazie.
progres Un șir de caractere, de forma %d/%d, în care primul număr reprezintă numărul de rotițe deja dezactivate în timpul invaziei, iar al doilea număr reprezintă dimensiunea totală a invaziei.

.

Lasă un răspuns

Adresa ta de email nu va fi publicată.