FR:API

This article is a work-in-progress
This means this article is not yet finished and someone is working on it.
You can help, by getting in contact with the last person which was editing this page.
Alternatively you can help by adding the missing content yourself! 🤍

API de Transport Tycoon

Cet API suit quelques principes de standard:

• Certaines routes renverront des données différentes en fonction du serveur choisi
• Chaque serveur demande une URL différente pour récupérer les données a la place d'une URL standardisée
• Les itinéraires legacy utilisent le chemein /status dans les URLs. Les adresses V1.api.tycoon sont routées automatiquement avec /status.

Serveurs disponibles

Note: Les adresses secondaires sont les addresses proxy de cfx.re- elles ont le meme usage

Addresses	Nom du Serveur	Information Additionelles
v1.api.tycoon.community/main tycoon-2epova.users.cfx.re/status	Serveur 1
v1.api.tycoon.community/beta tycoon-njyvop.users.cfx.re/status	Serveur 2 (Beta)	Serveur Beta, les données peuvent êtres différentes que les autres serveurs
lite.tycoon.community tycoon-dgpvx3.users.cfx.re	[LITE] Transportation	Un mode de jeux différent, ne répond pas au appels API Transport Tycoon. L'appel sessionmanager/players.json renvoie la liste des joueurs en ligne.

Fichier CDN de la Liste des Serveurs

Le CDN de Tycoon a un fichier JSON permanant qui contient la list des serveurs, les informations des jouers et un modèle pour formatter les appèles API pour chaque serveurs. En outre du serveurs Transport Tycoon principale, il inclue les informations pour le serveur [LITE] Transportation. Ce fichier est disponible a cette addresse https://cdn.tycoon.community/servers.json.

Clés API

TL;DR: Pour crée une nouvelle clé API, dans le jeux, utilisez la commande /api private new

Pour ajouter des charges sur la clé utilisez la commande /api private refill (cela ajoute 1000 charges pour $1M)

Ajouter x charges sur la clé utiliser la commande /api private refill x (cela ajoute x charges pour $1000* x)

L'API demande une clé a chaque fois qu'une information est accedé avec exceptions.

Chaque clé a un nombre limité d'appels API (également appelés frais), qui sont consommés chaque fois qu'un appel API est effectué à l'aide de la clé. Des charges supplémentaires peuvent être achetées dans le jeu à l'aide de la commande de recharge privée /api au prix de 1 000 $ (argent du jeu) par charge. Tout utilisateur peut générer une clé API ; cette clé est la clé privée dudit utilisateur. (Assurez-vous de le garder en sécurité !) Pour générer une clé, utilisez la nouvelle commande /api private new dans le jeu. Si vous avez déjà généré une clé, l'ancienne sera supprimée et une nouvelle prendra sa place. Lorsque vous générez une clé pour la première fois, elle s'accompagnera de frais gratuits vous permettant de tester l'API gratuitement. La clé API peut être copiée à l'aide de la commande /api private copy, qui affichera la clé que vous pourrez copier dans votre presse-papiers. Tout utilisateur avec un compte Discord lié recevra un rôle Discord lors du remplissage de ses clés.

Clés Publiques

Les clés publiques sont des clés qui peuvent être utiliser pour acceder les informations d'un joueur sans avoir besoin d'utiliser la clé du joueur et les charges. Ces clés font passer le compte cible du propriétaire de la clé API au propriétaire de la clé publique. La clé publique ne peut pas être utilisée comme clé API et ne fonctionne que lorsqu'elle est transmise avec une clé API valide.

Pour générer une clé publique, utilisez /api public generate

Options liées à la confidentialité

L'API étant de plus en plus utilisée, il est désormais possible de restreindre l'accès à vos données joueur/personnelles afin que seule votre clé API puisse l'interroger. Afin de restreindre l'accès, verrouillez /api dans le jeu et la confidentialité sera activée.

Points de terminaison de l'API

Notes générales

• Les clés API doivent être envoyées sous forme d'en-têtes, comme ceci : X-Tycoon-Key : [api-key]
• Les clés publiques sont envoyées avec l'en-tête X-Tycoon-Public-Key: [public-key]
• Chaque point de terminaison ici mentionnera si une clé doit être utilisée. Notez qu'actuellement, chaque itinéraire nécessitant une clé n'utilisera qu'une seule charge par requête.
• En règle générale, ces données sont renvoyées au format JSON, sauf mention explicite.
• La plupart des routes auront un en-tête de réponse appelé X-Tycoon-Charges, qui vous donnera le nombre de charges restantes après la requête.

Codes de réponses

• 400 Bad Request - point de terminaison non valide
• 401 Non autorisé - Une clé API est requise pour la route
• 402 Paiement requis - Aucun frais API restant
• 403 Interdit - Clé API non valide ou clé publique non valide
• 404 Introuvable - Route d'API non valide

---

Liste des points de terminaison

GET /endpoints.json

Renvoie toutes les terminaisons possibles du serveur selectioné. Cette valeur renvoyée doit toujours être la même quel que soit le serveur sur lequel elle est utilisée (hors beta et/ou event)