API del juego: Difference between revisions

From SimRail Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 77: Line 77:
Fuente: EDR oficial
Fuente: EDR oficial
===Parámetros===
===Parámetros===
Uno de los Identificadores del puesto: <code>BZ</code> <code>LZ_LC</code> <code>SG_R52</code> son los únicos compatibles durante la puesta en escena.
Uno de los Identificadores del puesto <code>BZ</code> <code>LZ_LC</code> <code>SG_R52</code> son los únicos compatibles durante la puesta en escena.
===Solicitud===
===Solicitud===
  https://staging.simrail.deadlykungfu.ninja/dispatch/BZ
  https://staging.simrail.deadlykungfu.ninja/dispatch/BZ

Revision as of 20:50, 11 April 2023

Logo API. Fuente pngegg.com

API Cuadro Horario del tren

Esta API recupera los horarios establecidos del tren para el número de tren especificado por el maquinista.

Fuente:

Secreta (por ahora)

https://staging.simrail.deadlykungfu.ninja/train/40684

Respuesta

Devolverá una matriz de la fila "TrainTimetableRow".

[
  {
    "train_number": "40684",
    "scheduled_arrival_hour": null,
    "station": "Tychy Lodowisko",
    "layover": null,
    "scheduled_departure_hour": "17:26",
    "train_type": "ROJ",
    "line": "179",
    "cachedate": "2023-02-12T18:48:23.975Z",
    "stop_type": "ph",
    "hourSort": 0
  },
  {
    "train_number": "40684",
    "scheduled_arrival_hour": "17:27",
    "station": "Tychy Miasto",
    "layover": "0.0",
    "scheduled_departure_hour": "17:27",
    "train_type": "ROJ",
    "line": "179",
    "cachedate": "2023-02-12T18:48:24.000Z",
    "stop_type": null,
    "hourSort": 1727
  }
]

La fila "TimeTableRow"

Campo Tipo Descripción
train_number Variable El número del tren
scheduled_arrival_hour Variable / nulo La hora prevista de llegada del tren a la estación
station Variable El nombre de la estación
layover Variable / nulo Tiempo de la parada (en minutos) si el tren se detiene en esta estación.
line Variable Vía por la que el tren circulará en esta estación.
cachedate Variable Hora en la que se actualizaron estos datos por última vez.
stop_type Variable / nulo Si efectúa parada en la estación, el tipo de escala (pH o PT). ph or pt
hourSort Numérica Hora (en formato HHmm) para ayudar a ordenar los datos o centrarse en la estación actual.

Cuadro horario del puesto de Control

Esta API recuperará el cuadro horario del puesto de Control.

Fuente: EDR oficial

Parámetros

Uno de los Identificadores del puesto BZ LZ_LC SG_R52 son los únicos compatibles durante la puesta en escena.

Solicitud

https://staging.simrail.deadlykungfu.ninja/dispatch/BZ

Respuesta

La respuesta será un ajuste de la fila "StationTimetableRow".

/!\ El cuadro horario del EDR oficial tiene un error según el cual algunos horarios de salida de los trenes difieren en 1 minuto entre el puesto de control y los datos del tren. Esto no supone un error de la API /!\.

[
  {
    "train_number": "14141",
    "train_type": "ECE",
    "type_speed": 0,
    "stop_type": null,
    "platform": " ",
    "arrival_time": "00:00",
    "departure_time": "00:00",
    "from_post": "Dąbrowa Górnicza",
    "to_post": "Sosnowiec Główny",
    "line": "1",
    "start_station": "Warszawa Grochów",
    "terminus_station": "Bohumin",
    "cachedate": "2023-02-12T18:08:32.837Z",
    "hourSort": 0
  },
  {
    "train_number": "41144",
    "train_type": "ECE",
    "type_speed": 0,
    "stop_type": null,
    "platform": " ",
    "arrival_time": "00:05",
    "departure_time": "00:05",
    "from_post": "Sosnowiec Główny",
    "to_post": "Dąbrowa Górnicza",
    "line": "1",
    "start_station": "Bohumin Vrbice",
    "terminus_station": "Warszawa Grochów",
    "cachedate": "2023-02-12T18:08:32.859Z",
    "hourSort": 5
  }
]

Fila "StationTimetableRow"

Contenido de cada elemento de la matriz:

Campo Tipo Descripción
train_number Variable El número del tren
train_type Variable El tipo de tren
type_speed Numérico / Indefinido La velocidad máxima para el tipo de tren (si tenemos dicha información).
platform Variable El andén en que se detendrá el tren, por ejemplo I 1
arrival_time Variable Hora prevista de llegada del tren
departure_time string Hora establecida de salida del tren
from_post Variable Estación de procedencia del tren
to_post Variable Estación hacia la que se dirige el tren.
line string La vía por la que se debe enviar el tren.
start_station string La estación de origen del tren
terminus_station Variable La estación término del tren
cachedate Variable La última vez que se actualizaron los datos desde la fuente.
hourSort Numérico Valor de clasificación de carácter interno, que también puede ayudar a enfocar la fila actual.

Perfiles de Steam (Steam profiles)

Devuelve el nombre de usuario y el avatarUrl de un usuario determinado sin llamar a la API de SimRail y la mantiene en caché durante un día.

Solicitud

https://staging.simrail.deadlykungfu.ninja/steam/<steam_id>

Respuesta

Una matriz que contiene un elemento con sus datos.

[
  {
    "avatar": "https://avatars.akamai.steamstatic.com/70845eef7475441ffc0c9f9685cf40a57df07e15.jpg",
    "pseudo": "Someone"
  }
]

Información del tren ofrecida por el servidor

n/a

Autor: DeadlyKungFu.Ninja

Sitio Web: http://docs.simrail.deadlykungfu.ninja/