ToontownRewritten / api-doc

Aperçu

Les API sur l’état actuel du monde du jeu sont toujours amusantes, donc TTR a publié notre tracker d’invasion interne au monde via une API consommable publiquement.

La conception de cette API est guidée par l’implémentation du suivi d’invasion réel sur les serveurs de TTR. Chaque district envoie périodiquement les données d’invasion actuelles à un serveur central (bien que ce serveur ne soit pas notre serveur web), où elles sont stockées en mémoire. Sur une horloge séparée, la couche web de TTR interroge périodiquement ce serveur central pour obtenir les dernières données d’invasion, qui sont ensuite mises en cache et renvoyées à tous ceux qui interrogent l’API des invasions. Cette conception est flexible et nécessite peu de ressources supplémentaires pour fonctionner, bien que les données ne soient pas aussi fraîches en conséquence.

Note : L’en-tête Access-Control-Allow-Origin est défini sur * sur cette API.

Requêtes

Un GET HTTP vers le point de terminaison de l’API invasions, https://www.toontownrewritten.com/api/invasions, renverra la dernière réponse JSON. Aucun paramètre n’est requis, cependant, si vous effectuez fréquemment des appels à cette API, j’apprécierais que vous définissiez un User-Agent descriptif.

Réponse

Nom Détails
erreur Lorsque des données sont présentes, error sera mis à null. Si error n’est pas nul, alors aucun autre champ ne sera présent, et error sera mis à un message d’erreur
invasions Un dictionnaire de noms de districts aux données d’invasion.
lastUpdated Horloge d’époque de la dernière interrogation de données par la couche web.

Données d’invasion

Nom Détails
type Le nom du rouage d’invasion. Le nom localisé sera toujours en anglais, et sera toujours la forme singulière du cog. Si le cog est un skelecog, (Skelecog) sera ajouté. Si le cog est une version 2.0, Version 2.0 sera ajouté au début.
asOf L’horodatage d’époque de la dernière fois où le district a signalé son état d’invasion.
progress Chaîne de caractères, de la forme %d/%d, où le premier nombre représente le nombre de cogs déjà despawnés pendant l’invasion et le deuxième nombre représente la taille totale de l’invasion.

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée.