Server API Documentation
Получение информации о Вашем сервере в формате json:-Может использоваться для статуса сервера на сайте.
-Изменения статуса, описания и т.д. одновременно на всех ресурсах, использующих наше API.
Данные:
-URL для запросов API- https://rust-server.com/api/v1/.
-object=servers- обязательный параметр. Запрос данных из раздела серверов.
-element=detail- обязательный параметр. Запрос на выборку данных сервера.
-key={ServerKey}- обязательный параметр. ApiKey сервера. Генерируется при верификации сервера.
https://rust-server.com/api/v1/?object=servers&element=detail&key={ServerKey}
error json:
| key | response | description |
|---|---|---|
| error | unknown request | unknown GET request, check that the variables are correct! |
| error | invalid server key | unknown server ApiKey. The server does not exist or there is an ApiKey error |
json:
| # | key | value | description |
|---|---|---|---|
| 1 | id | int | server id |
| 2 | host_name | text | title server |
| 3 | ip | ip | ip addres server |
| 4 | port | int | game port server |
| 5 | players | int | number of players |
| 6 | max_players | int | max players |
| 7 | online | int | number of players online |
| 8 | map | text | type map |
| 9 | version | int | version server |
| 10 | size | int | size map |
| 11 | seed | int | seed map |
| 12 | query_port | int | query port server |
| 13 | description | text | description server |
| 14 | url | text | url your site |
| 15 | tg | text | telegram |
| 16 | discord | text | discord |
| 17 | webhook | text | webhook discord |
| 18 | active | int | active monitoring |
| 19 | vote_up | int | vote up |
| 20 | vote_down | int | vote down |
| 21 | rating | int | rating |
| 22 | date | format d.m.Y H:i | add to rust-server.com |
Получение информации о голосовании пользователя за последние 4 часа:
-Может использоваться для вознагрождение игрока за голосование.-Наше API показывает информацию о голосовании за последние 4 часа.
Данные:
-URL для запросов API- https://rust-server.com/api/v1/.
-object=vote- обязательный параметр. Запрос данных из раздела голосования.
-element=status- обязательный параметр. Запрос на выборку данных голосования.
-key={ServerKey}- обязательный параметр. ApiKey сервера. Генерируется при верификации сервера.
-steamid={SteamId}- обязательный параметр. STEAMID игрока.
https://rust-server.com/api/v1/?object=vote&element=status&key={ServerKey}&steamid={SteamId}
| Response | Description |
|---|---|
| 0 | There was an issue with the server key, steamid, username, or the player has not voted in the last 4 hours! |
| 1 | Player has voted in the last 4 hours and has not claimed their reward. |
| 2 | Player has voted in the last 4 hours and has claimed their reward. |
Изменение статуса голосования пользователя за последние 4 часа:
Данные:-URL для запросов API- https://rust-server.com/api/v1/.
-object=vote- обязательный параметр. Запрос данных из раздела голосования.
-element=claim- обязательный параметр. Запрос на изменение статуса голосования.
-key={ServerKey}- обязательный параметр. ApiKey сервера. Генерируется при верификации сервера.
-steamid={SteamId}- обязательный параметр. STEAMID игрока.
https://rust-server.com/api/v1/?object=vote&element=claim&key={ServerKey}&steamid={SteamId}
| Response | Description |
|---|---|
| 0 | There was an issue with the server key, steamid, username, or the player has not voted in the last 4 hours! |
| 1 | Player has voted in the last 4 hours and vote is set as claim. (You can reward them!) |
| 2 | Player has voted in the last 4 hours and has already claimed their reward! (DO NOT REWARD THEM!) |