Используется для доступа к спискам лидеров Steam.
Дополнительная информация об использовании веб-API Steamworks доступна в разделе
Обзор веб-API.
DeleteLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
appid | uint32 | ✔ | AppID игры |
name | string | ✔ | название списка лидеров, который необходимо удалить |
ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
FindOrCreateLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/FindOrCreateLeaderboard/v2/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
appid | uint32 | ✔ | AppID игры |
name | string | ✔ | название списка лидеров, который необходимо создать |
sortmethod | string | | метод сортировки для использования в списке лидеров (по умолчанию используется «по возрастанию») |
displaytype | string | | тип отображения списка лидеров (по умолчанию цифровой) |
createifnotfound | bool | | Если true, ещё не существующий список лидеров будет создан. По умолчанию — true. |
onlytrustedwrites | bool | | Если true, клиенты не смогут задавать данные об очках в списках лидеров. Это сможет сделать только издатель с помощью SetLeaderboardScore (веб-API). По умолчанию — false. |
onlyfriendsreads | bool | | Если true, данные списка лидеров смогут считываться только друзьями пользователя. Издатель всегда сможет прочесть все данные списка. По умолчанию — false. |
Существуют предыдущие версии данного метода, которые больше официально не поддерживаются. Их по-прежнему можно использовать, однако настоятельно рекомендуется использовать самую последнюю версию.
История изменений:
- Версия 2 - исправлена ошибка возвращения названия списка лидеров в формате XML.
ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
GetLeaderboardEntries
GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardEntries/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
appid | uint32 | ✔ | AppID игры |
rangestart | int32 | ✔ | начало диапазона или 0 |
rangeend | int32 | ✔ | конец диапазона или максимальное число записей в списке |
steamid | uint64 | | SteamID, используемый для запросов данных друзей и пользователей вокруг |
leaderboardid | int32 | ✔ | ID списка лидеров для просмотра |
datarequest | uint32 | ✔ | типы запроса: RequestGlobal, RequestAroundUser, RequestFriends |
ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
GetLeaderboardsForGame
GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardsForGame/v2/
Страна | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
appid | uint32 | ✔ | AppID игры |
Существуют предыдущие версии данного метода, которые больше официально не поддерживаются. Их по-прежнему можно использовать, однако настоятельно рекомендуется использовать самую последнюю версию.
История изменений:
- Версия 2 - исправлена ошибка возвращения названия списка лидеров в формате XML.
ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
ResetLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
appid | uint32 | ✔ | AppID игры |
leaderboardid | uint32 | ✔ | номер целевого списка, который можно получить от GetLeaderboardsForGame |
ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!
SetLeaderboardScore
POST https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/v1/
Название | Тип | Обязательно? | Описание |
key | string | ✔ | Ключ веб-API Steamworks для аутентификации издателя. |
appid | uint32 | ✔ | AppID игры |
leaderboardid | uint32 | ✔ | номер целевого списка, который можно получить от GetLeaderboardsForGame |
steamid | uint64 | ✔ | SteamID, данные об очках которого необходимо задать |
score | int32 | ✔ | данные об очках, которые необходимо задать для этого пользователя |
scoremethod | string | ✔ | методы обновления данных: "KeepBest" или "ForceUpdate" |
details | rawbinary | | информация о том, как были заработаны очки (макс. 256 байтов) |
ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API
ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!