Game API: Difference between revisions

From SimRail Wiki
Jump to navigation Jump to search
No edit summary
(He traducido al español el texto original)
Tag: Reverted
Line 1: Line 1:
[[File:Api pngegg.png|thumb|300x300pixel|API logo, source pngegg.com]]
[[File:Api pngegg.png|thumb|300x300pixel|API logo, source pngegg.com]]
==Train Timetable API==
==API Horario del tren==
This API retrieves train schedules for the train number specified by the driver.
Esta API recupera los horarios de los trenes correspondientes al número de tren especificado por el maquinista.
===Source:===
===Fuente:===
Secret -for now-
De momento, secreta.
  https://staging.simrail.deadlykungfu.ninja/train/40684
  https://staging.simrail.deadlykungfu.ninja/train/40684
===Response===
===Respuesta===
Will return an array of TrainTimetableRow
Devolverá una matriz de la TrainTimetableRow (Fila)
  [
  [
   {
   {
Line 33: Line 33:
   }
   }
  ]
  ]
====TimeTableRow====
====Fila Horario====
{| class="wikitable"
{| class="wikitable"
!Field
!Campo
!Type
!Tipo
!Description
!Descripción
|-
|-
|train_number
|Train number
|<code>string</code>
|<code>variable</code>
|The number of the train
|El número del tren
|-
|-
|scheduled_arrival_hour
|scheduled_arrival_hour
|<code>string / null</code>
|<code>variable / nulo</code>
|The time the train should arrive at the station
|La hora de llegada del tren a la estación
|-
|-
|station
|Station
|<code>string</code>
|<code>variable</code>
|The station name
|El nombre de la estación
|-
|-
|layover
|Layover
|<code>string / null</code>
|<code>variable / nulo</code>
|Time in minutes of the layover if the train stops at this station
|Tiempo de la parada en minutos si el tren se detiene en esta estación.
|-
|-
|line
|Line
|<code>string</code>
|<code>variable</code>
|The line the train will be running at this station
|La ía por la que ese tren accederá a la estación.
|-
|-
|cachedate
|cachedate
|<code>string</code>
|<code>variable</code>
|Time this data was updated for the last time
|Hora en la que se actualizaron estos datos por última vez.
|-
|-
|stop_type
|stop_type
|<code>string / null</code>
|<code>variable / nulo</code>
|If there is a stop at the station, the type of the layover. <code>ph</code> or <code>pt</code>
|Si hay una parada en la estación, el tipo de escala. <code>ph</code> o <code>pt</code>
|-
|-
|hourSort
|hourSort
|<code>number</code>
|<code>numérico</code>
|Hour in HHmm format to help sorting the data or focus the current station
|Hora (en formato HHmm) para ayudar a ordenar los datos o centrarse en la estación actual.
|}
|}
==Dispatch station timetables==
==Horarios del puesto de Control==
This API will return the timetable of the station post
Esta API recuperará el cuadro horario del puesto de Control.


Source: Official EDR
Fuente: EDR oficial
===Parameters===
===Parámetros===
One of the Post id: <code>BZ</code> <code>LZ_LC</code> <code>SG_R52</code> are the only ones supported during staging
Uno de los identificadores de Puesto (Post id): <code>BZ</code> <code>LZ_LC</code> <code>SG_R52</code> son los únicos admitidos durante la recopilación
===Request===
===Solicitud===
  https://staging.simrail.deadlykungfu.ninja/dispatch/BZ
  https://staging.simrail.deadlykungfu.ninja/dispatch/BZ
===Response===
===Respuesta===
The response will be an Array of StationTimetableRow
La respuesta será un ajuste de la fila StationTimetableRow


''/!\ The official EDR timetable has a bug where some departure times for trains differ of 1minute between dispatch and train data. This is not an API bug /!\''
''/!\ 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 /!\.''
  [
  [
   {
   {
Line 118: Line 118:
  ]
  ]
====StationTimetableRow====
====StationTimetableRow====
Content of each elements of the array:
Contenido de cada elemento de la matriz:
{| class="wikitable"
{| class="wikitable"
!Field
!Campo
!Type
!Tipe
!Description
!Descripción
|-
|-
|train_number
|train_number
|<code>string</code>
|<code>variable</code>
|The number of the train
|El número del tren
|-
|-
|train_type
|train_type
|<code>string</code>
|<code>variable</code>
|The type of the train
|El tipo de tren
|-
|-
|type_speed
|type_speed
|<code>number / undefined</code>
|<code>numérico / indefinido</code>
|The maximum speed for the train type, if we have such info
|La velocidad máxima para el tipo de tren (si disponemos de dicha información).
|-
|-
|platform
|platform
|<code>string</code>
|<code>variable</code>
|The platform the train will stop. Example <code>I 1</code>
|El andén en que se detendrá el tren, por ejemplo <code>I 1</code>
|-
|-
|arrival_time
|arrival_time
|<code>string</code>
|<code>variable</code>
|Scheduled arrival time of the train
|Hora de llegada prevista del tren.
|-
|-
|departure_time
|departure_time
|<code>string</code>
|<code>variable</code>
|Scheduled departure time of the train
|Hora de salida del tren.
|-
|-
|from_post
|from_post
|<code>string</code>
|<code>variable</code>
|The station where the train comes from
|Estación de procedencia del tren.
|-
|-
|to_post
|to_post
|<code>string</code>
|<code>variable</code>
|The station where the train goes
|Estación hacia la que se dirige el tren.
|-
|-
|line
|line
|<code>string</code>
|<code>variable</code>
|The line the train needs to be sent to
|La vía por la que se debe enviar el tren.
|-
|-
|start_station
|start_station
|<code>string</code>
|<code>variable</code>
|The starting station of the train
|La estación origen del tren.
|-
|-
|terminus_station
|terminus_station
|<code>string</code>
|<code>variable</code>
|The terminus station of the train
|La estación término del tren.
|-
|-
|cachedate
|cachedate
|<code>string</code>
|<code>variable</code>
|The last time the data was updated from the source
|La última vez que se actualizaron los datos desde la fuente.
|-
|-
|hourSort
|hourSort
|<code>ǹumber</code>
|<code>numérico</code>
|Internal sorting value, can also help to focus current row
|Valor de clasificación de carácter interno, que también puede ayudar a enfocar la fila actual.
|}
|}
==Steam profiles==
==Perfiles de Steam (Steam profiles)==
Returns the username and the avatarUrl of a given user without calling SimRail API and cached for a day
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.
===Request===
===Solicitud===
  [https://staging.simrail.deadlykungfu.ninja/steam/%3Csteam_id%3E https://staging.simrail.deadlykungfu.ninja/steam/<steam_id>]
  [https://staging.simrail.deadlykungfu.ninja/steam/%3Csteam_id%3E https://staging.simrail.deadlykungfu.ninja/steam/<steam_id>]
===Response===
===Respuesta===
An array containing one object with the data
Una matriz que contiene un elemento con sus datos.
  [
  [
   {
   {
Line 188: Line 188:
   }
   }
  ]
  ]
==Train infos by server==
==Información del tren por el Servidor==
n/a
n/a


''Author: DeadlyKungFu.Ninja''
''Autor: DeadlyKungFu.Ninja''


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

Revision as of 13:20, 27 March 2023

API logo, source pngegg.com

API Horario del tren

Esta API recupera los horarios de los trenes correspondientes al número de tren especificado por el maquinista.

Fuente:

De momento, secreta. 

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

Respuesta

Devolverá una matriz de la TrainTimetableRow (Fila) 

[
  {
    "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
  }
]

Fila Horario

Campo Tipo Descripción
Train number variable El número del tren
scheduled_arrival_hour variable / nulo La hora 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 La ía por la que ese tren accederá a la estación.
cachedate variable Hora en la que se actualizaron estos datos por última vez.
stop_type variable / nulo Si hay una parada en la estación, el tipo de escala. ph o pt
hourSort numérico Hora (en formato HHmm) para ayudar a ordenar los datos o centrarse en la estación actual.

Horarios del puesto de Control

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

Fuente: EDR oficial

Parámetros

Uno de los identificadores de Puesto (Post id): BZ LZ_LC SG_R52 son los únicos admitidos durante la recopilación

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
  }
]

StationTimetableRow

Contenido de cada elemento de la matriz:

Campo Tipe 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 disponemos de dicha información).
platform variable El andén en que se detendrá el tren, por ejemplo I 1
arrival_time variable Hora de llegada prevista del tren.
departure_time variable Hora 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 variable La vía por la que se debe enviar el tren.
start_station variable La estación 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 por el Servidor

n/a

Autor: DeadlyKungFu.Ninja

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

Retrieved from "https://wiki.simrail.cz/subdom/wiki/index.php?title=Game_API&oldid=5993"