REST API 500 error when challenging player

OGS Development API Development
1

I have been trying to use the REST API in order to create a challenge to a specific player and I keep getting a 500 error. I am doing a POST request to the endpoint https://online-go.com/api/v1/players/1010712/challenge/, where the body of the request is as follows

{
    "game": {
        "name": "Rengo game",
        "rules": "chinese",
        "ranked": false,
        "handicap": 0,
        "time_control": "simple",
        "time_control_parameters": {
            "system": "simple",
            "speed": "correspondence",
            "per_move": 2419000.0
        },
        "pause_on_weekends": true,
        "width": 19,
        "height": 19,
        "disable_analysis": false
    },
    "challenger_color": "black",
    "min_ranking": 0,
    "max_ranking": 30
}

Am I missing something with this?

2

Rengo is not supported :smiley: :wink:

Just joking.

Can you clarify what other authorised calls you have (or have not) had success with?

IE are you still on the ramp up of how to use the API as a logged in player, or is this a specific problem with challenges?

1 Like
3

I have been able to access the /api/v1/me/settings endpoint, but have not had any success with others yet (I haven’t done extensive testing with them yet, challenging is the first part).

Hopefully, when I get everything with this project working rengo will be supported :slight_smile:

1 Like
4

You may just be reaching the /me endpoint because you have the cookies on your computer for your own personal account.

You first need to get the authentication token API For Online Go (OGS) · Apiary
and send that along in the header
image

Secondly, this is the body I send

{"initialized":false,"min_ranking":-1000,"max_ranking":1000,"challenger_color":"<challenger_color>","game":{"name":"<name>","rules":"<rules>","ranked":<ranked>,"width":<width>,"height":<height>,"handicap":"<handicap>","komi_auto":"custom","komi":<komi>,"disable_analysis":<disable_analysis>,"initial_state":null,"private":false,"time_control":"<time_control>","time_control_parameters":{"system":"<time_control>","speed":"<t_speed>","total_time":<total_time>,"initial_time":<initial_time_sec>,"time_increment":<time_incriment_sec>,"max_time":<max_time_sec>,"main_time":<main_time>,"period_time":<period_time>,"periods":<periods>,"per_move":<simple_per_move>,"stones_per_period":<stones_per_period>,"pause_on_weekends":false,"time_control":"<time_control>"},"pause_on_weekends":false},"aga_ranked":false}

(where the <text> are game specific variables)

5

Out if curiosity, what are you working on?

6

Thank you so much! It looks like I was missing a couple of parameters that were not specified in the documentation. It also seemed to help (I’m using the python requests module) when I manually specified the Content-Type header (I thought I didn’t need to, but I guess providing custom headers overrides that) and by using the json parameter instead of the data parameter

7

I am working on a Discord bot that will work to handle rengo on OGS by having an unranked game between 2 accounts controlled by the bot, where the moves come from a Discord server

8

glad it helped. Yeah, unfortunately some of the params are not listed in the documentation. I lifted them either from elsewhere on the forum and/or I inspected the network logs of OGS when making a game

9

sounds neat! I once set up a site where players were shown an iframe of OGS and given a login to use in the iframe. Then I blocked the players moves when it wasn’t there turn and showed some visuals as well.

The discord bot will likely work better, haha.

10

Yeah, inspecting my network traffic was going to be my next step if I didn’t get a response soon enough. I very well may end up doing that for the other endpoints I need, if I can’t figure them out

11

That sounds like a cool way of doing it. Hopefully this bot works out and catches on among the player base. I plan on making it open-source once it’s working, so anyone can register a bot and use it

1 Like