Matchmaking API: Difference between revisions
No edit summary |
No edit summary |
||
| Line 20: | Line 20: | ||
! rowspan="2" | Key | ! rowspan="2" | Key | ||
! rowspan="2" | Type | ! rowspan="2" | Type | ||
! colspan=" | ! colspan="3" | Endpoints | ||
! rowspan="2" | Description | ! rowspan="2" | Description | ||
|- | |- | ||
| get-games | |||
| details | |||
| create | |||
|- | |- | ||
| application_version.build_mode | | application_version.build_mode | ||
| Line 32: | Line 31: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 40: | Line 38: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 48: | Line 45: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 56: | Line 52: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 64: | Line 59: | ||
| | | | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 72: | Line 66: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| ✓ | |||
| | |||
|- | |||
| game_secret | |||
| string | |||
| | | | ||
| | | | ||
| ✓ | |||
| | | | ||
|- | |- | ||
| Line 80: | Line 80: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 88: | Line 87: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 96: | Line 94: | ||
| | | | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 104: | Line 101: | ||
| | | | ||
| ✓ | | ✓ | ||
| | | | ||
| | | | ||
| Line 112: | Line 108: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 119: | Line 114: | ||
| number | | number | ||
| ✓ | | ✓ | ||
| | | | ||
| | | | ||
| Line 128: | Line 122: | ||
| | | | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 136: | Line 129: | ||
| | | | ||
| ✓ | | ✓ | ||
| | | | ||
| | | | ||
| Line 144: | Line 136: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 152: | Line 143: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | | ||
| | | | ||
| Line 160: | Line 150: | ||
| | | | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|- | |- | ||
| Line 168: | Line 157: | ||
| ✓ | | ✓ | ||
| ✓ | | ✓ | ||
| | | | ||
| | | | ||
| Line 176: | Line 164: | ||
| | | | ||
| ✓ | | ✓ | ||
| | | ✓ | ||
| | | | ||
|} | |} | ||
Revision as of 20:01, 8 January 2017
The matchmaking API allows Factorio servers to advertise themselves, and for players to browse open game servers. The matchmaking server currently uses Heroku and Green Unicorn software.
API root: https://multiplayer.factorio.com/
Some of the API endpoints require the use of an authentication token, which is obtained through the Web Authentication API. It is sent as the HTTP parameter named token and encoded using hexadecimal. For GET requests it is sent as part of the URL, and for POST requests it is sent as a POST parameter.
Work in progress! I'm just going to jot down some random notes in the mean time :P
https://multiplayer.factorio.com/create-game
https://multiplayer.factorio.com/post-game-heartbeat/
https://multiplayer.factorio.com/get-games
https://multiplayer.factorio.com/get-game-details/ Unauthenticated
| Key | Type | Endpoints | Description | ||
|---|---|---|---|---|---|
| get-games | details | create | |||
| application_version.build_mode | string | ✓ | ✓ | ✓ | |
| application_version.build_version | string(number) | ✓ | ✓ | ✓ | |
| application_version.game_version | string | ✓ | ✓ | ✓ | |
| application_version.platform | string | ✓ | ✓ | ✓ | |
| description | string | ✓ | ✓ | ||
| game_id | number | ✓ | ✓ | ✓ | |
| game_secret | string | ✓ | |||
| game_time_elapsed | string(number) | ✓ | ✓ | ✓ | |
| has_password | string(boolean) | ✓ | ✓ | ✓ | |
| host_address | string(ip:port) | ✓ | ✓ | ||
| last_heartbeat | number | ✓ | |||
| max_players | string(number) | ✓ | ✓ | ✓ | |
| mod_count | number | ✓ | |||
| mods | mod[] | ✓ | ✓ | ||
| mods_crc | number | ✓ | |||
| name | string | ✓ | ✓ | ✓ | |
| players | string[] | ✓ | ✓ | ||
| require_user_verification | string(boolean) | ✓ | ✓ | ||
| server_id | string | ✓ | ✓ | ||
| tags | string[] | ✓ | ✓ | ||