Dedicated server API

Discussion in 'Community Workshop' started by J-F Chardon, Apr 23, 2018.

  1. J-F Chardon

    J-F Chardon Sector3 Producer Developer

    Joined:
    Jan 15, 2015
    Ratings:
    +4,643 / 0 / -0
    I've just realized when someone asked for an API that there hadn't been a thread here about the dedicated server API.

    This is what allows leagues like RaceRoomers in Brazil or the SimRacing System to operate.

    Follow these steps in order to access the API documentation:

    NOTE: If you had swagger files locally from a previous update, clear them first. They are now included with the dedicated server files instead.

    upload_2019-5-29_12-42-6.png
     
    • Like Like x 3
    • Wonderful Wonderful x 1
    Last edited: May 29, 2019
  2. Racki

    Racki Well-Known Member Beta tester

    Joined:
    Aug 17, 2015
    Ratings:
    +128 / 0 / -0
    Is there anything I can do wrong here?
     
  3. J-F Chardon

    J-F Chardon Sector3 Producer Developer

    Joined:
    Jan 15, 2015
    Ratings:
    +4,643 / 0 / -0
    Will add more info to first post :p You need swagger.
     
  4. J-F Chardon

    J-F Chardon Sector3 Producer Developer

    Joined:
    Jan 15, 2015
    Ratings:
    +4,643 / 0 / -0
    OP edited.
     
    • Like Like x 1
  5. Luís de Gomes

    Luís de Gomes Member Beta tester

    Joined:
    Jun 7, 2017
    Ratings:
    +17 / 0 / -0
    Helloooo!

    After this last update its not possible anymore to use swagger?
     
    • Agree Agree x 2
  6. axxis278

    axxis278 Well-Known Member

    Joined:
    Jan 29, 2015
    Ratings:
    +48 / 0 / -0
    • Agree Agree x 1
  7. marcoscavaleiro

    marcoscavaleiro New Member

    Joined:
    Jun 30, 2016
    Ratings:
    +4 / 0 / -0
    • Agree Agree x 1
  8. DC-SIMRACING.NL

    DC-SIMRACING.NL Active Member

    Joined:
    Jan 3, 2019
    Ratings:
    +26 / 0 / -0
    Can someone explain me in simple words what this "Dedicated server API" mean and what we can do with this?
     
  9. J-F Chardon

    J-F Chardon Sector3 Producer Developer

    Joined:
    Jan 15, 2015
    Ratings:
    +4,643 / 0 / -0
    Updated OP !
     
  10. J-F Chardon

    J-F Chardon Sector3 Producer Developer

    Joined:
    Jan 15, 2015
    Ratings:
    +4,643 / 0 / -0
    You can control the dedicated server with your own home made interface, or add new logging tools, etc.
    We just happen to ship our own web page to interface with the dedicated servers, but everyone is free to make their own.

    This is for example what is used by SRS, RaceRoomers.pt, etc to have automated "on-demand" dedicated server spawns.
     
    • Like Like x 1
    • Informative Informative x 1
  11. filth

    filth Member

    Joined:
    Nov 3, 2019
    Ratings:
    +20 / 0 / -0
    Is it possible to access user car telemetry / laptime / position on track over the dedicated api? On a first quick look i could not locate any suitable methods
     
  12. Roman TRT

    Roman TRT Well-Known Member

    Joined:
    Jun 3, 2015
    Ratings:
    +71 / 0 / -0
    on the page of the ranking server, I see the column "who is online".
    As a wish), I think the developers could give different tips on using the API. For example, I do not have the knowledge to implement such widgets on my sites, and it will be expensive for money. After all, from such help, and for the development of the game is better...
     
  13. yoori

    yoori Well-Known Member

    Joined:
    Feb 10, 2017
    Ratings:
    +72 / 0 / -0
    I've got a problem viewing the API documentation.
    upload_2020-3-21_11-30-6.png
     
  14. Koenvh

    Koenvh Member

    Joined:
    Feb 3, 2020
    Ratings:
    +6 / 0 / -0
    Hi, I was wondering whether there is any API to get the rating/reputation of a player. It does not seem to be part of the data returned by the dedicated server, or by game.raceroom.com/utils/user-info, nor could I find it anywhere else on the game.raceroom.com. However, it is displayed in the game, and the Discord bot somehow gets the data, so did I miss something, or will it later be added to the user-info API?
     
    • Funny Funny x 1
  15. Koenvh

    Koenvh Member

    Joined:
    Feb 3, 2020
    Ratings:
    +6 / 0 / -0
    There is a call to restart a session, something that is not included as a button in the normal interface, but has appeared as a button next to the "Next session" button in old screenshots from @J-F Chardon . What is the reason that this button is no longer there? Does that mean you advice against using that endpoint?

    And a feature request from my side: It would be nice if a message could be added when a player is kicked, so that they know why they have been kicked (high ping, crashing, etc.)
     
    • Agree Agree x 1
    Last edited: Apr 22, 2020
  16. J-F Chardon

    J-F Chardon Sector3 Producer Developer

    Joined:
    Jan 15, 2015
    Ratings:
    +4,643 / 0 / -0
    There are a few features that we didn't add buttons for until I feel they're safe for server admins to use.
    I had pushed this aside as we lacked a bit on a testing side, but it's good that you remind me, I'll try and get this tested asap.
     
    • Like Like x 2
  17. Roman TRT

    Roman TRT Well-Known Member

    Joined:
    Jun 3, 2015
    Ratings:
    +71 / 0 / -0
    and where can I get a breakdown of new incidents in the results logs?
    Type 1-8
    preferably the whole list at once)
     
  18. Koenvh

    Koenvh Member

    Joined:
    Feb 3, 2020
    Ratings:
    +6 / 0 / -0
    • Type 0 = Car to car collision
    • Type 1 = Collision with a track object
    • Type 2 = Going the wrong way
    • Type 3 = Going off track
    • Type 4 = Staying stationary on the track
    • Type 5 = Losing control of the vehicle
    • Type 6 = Not serving a penalty
    • Type 7 = Disconnecting / Giving up before the end of a race
    • Type 8 = Missing the race start
     
  19. Roman TRT

    Roman TRT Well-Known Member

    Joined:
    Jun 3, 2015
    Ratings:
    +71 / 0 / -0
    Type 8 = Missing the race start
    But can you describe this incident in more detail?
    through the translator it is not clear what I mean)
     
  20. yoori

    yoori Well-Known Member

    Joined:
    Feb 10, 2017
    Ratings:
    +72 / 0 / -0
    Actually that list is not up to date AFAIK.
    Invalid lap was added as 6. I'm not sure if missions start is 9 now.
    Regarding missing start, when the race session starts you have 60s to join the grid if you fail to do that you are placed in the pits.

    0 Car to car collision
    1 Collision with a track object
    2 Going the wrong way
    3 Going off track
    4 Staying stationary on the track
    5 Losing control of the vehicle
    6 Invalid Lap
    7 Not serving a penalty
    8 Disconnecting / Giving up before the end of a race