Difference between revisions of "NL:API"

From Tycoon Gaming
m
m
 
(No difference)

Latest revision as of 00:16, 17 October 2020

English

Transport Tycoon API

Root API URI is het adres van de server

API is beschikbaar per server instantie

API Keys

TL;DR: Maak een nieuwe key met /api key new

Voeg charges toe met /api key refill (voegt 1000 charges voor $1M)


De API vereist een API-sleutel om toegang te krijgen tot de meeste functies.

Elke sleutel heeft een beperkt aantal API Calls (ook wel charges genoemd), die elke keer dat een API Call wordt gedaan met de key wordt verbruikt.

Extra cahrges kunnen in de game worden gekocht met de /api key refill command voor de kost van $1000 (in-game geld) per charge.

Elke gebruiker kan een API Key genereren, deze key is de privésleutel van de gebruiker.

Om een key te genereren, gebruikt u de/api key new command in-game.

Als u al een key heeft gegenereerd, wordt de oude verwijderd en komt er een nieuwe in de plaats.

Wanneer u voor de eerste keer een key genereert, worden er enkele gratis charges voor in rekening gebracht, zodat u de API gratis kunt testen.

De API key kan worden gekopieerd met de /api key copy command. (Dit zal uw key op het scherm laten zien!)

Voor developers

De API key moet worden geplaatst als een `X-Tycoon-Key` header.

Key Gerelateerde Endpoints

/charges.json Geeft het resterende charges terug (geen charges verbruikt om te controleren)

Legenda

type name (gegevenstype en een eigenschapnaam)
type? name (het gegevenstype kan variëren op basis van de gegevenscontext)
type! name (gegevens bestaan mogelijk niet op basis van gegevenscontext)

Note: Array-gegevenstypen bevatten geen benoemde eigenschappen, de namen die hier worden gebruikt, zijn ter verduidelijking

Krijg wereldinformatie voor online spelers

Retourneert een lijst met alle online spelers met positiegegevens.

Hun huidige vervoerswijze en enkele andere details zijn ook opgenomen.

Dit eindpunt wordt gebruikt om de live map van de server te produceren.

GET /status/map/positions.json
object
- int time
- array[array player] data
-- string name
-- int source
-- int user_id
-- vec3 position
-- object owned_vehicles
--- object[string vehicle_type]!
---- string vehicle_spawn
-- object vehicle
--- int vehicle_class
--- string vehicle_type
--- int! model
--- string! vehicle_label
--- string! vehicle_name
--- bool? has_trailer
--- string! trailer
--- string! vehicle_spawn
-- object job
--- string group
--- string name

Krijg servergegevens en online spelers

Retourneert de servernaam en details, evenals gegevens voor elke online speler.

Dit eindpunt wordt gebruikt om de serverlijst te produceren: http://connect.tycoon.community/

GET /status/widget/players.json
object
- object server
-- string name
-- string motd
-- string number
-- string region
-- string beta
-- string uptime
-- int limit
- array[array player] players
-- string name
-- int source
-- int user_id
-- string? avatar
-- bool staff
-- string job_name
-- bool whitelist

Get Online Players

Returns a list of online players

GET /status/players.json
array players
- string name
- int? source
- int user_id

Airline Routes

Retourneert de actieve Airline Pilot-routes op de server

GET /status/airline.json
object
- object[string player] player
-- string plane
-- object destination
--- float x
--- float y
--- float z
--- float h
--- string airport
--- string name
-- bool atTerminal

Krijg resourceconfiguraties

Dit kan worden gebruikt om gemakkelijk vectorgegevens voor routes enz. In bepaalde banen te krijgen Niet alle bronnen hebben zichtbare configuraties

GET /status/config/[resource]
returns a raw .lua file dump

Top10 Statistieken

Retourneert een lijst met de top 10 voor de stat in aflopende volgorde.
Notitie: Gebruikersnamen zijn nogal onbetrouwbaar, dus de kans is groot dat ze een verkeerde indeling hebben of ongeldige tekens bevatten.

Enkele geldige statistieken:
firefighter_streak_record
omni_void_leaderboard
ems_streak_record
houses_crafted
toll_paid
drops_collected

GET /status/top10/[stat]
object
-array top
-- int user_id
-- string user_name
-- int stat_count