Документация Steamworks
Интерфейс ISteamLeaderboards
Используется для доступа к спискам лидеров Steam.

Дополнительная информация об использовании веб-API Steamworks доступна в разделе Обзор веб-API.

DeleteLeaderboard

POST https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/
НазваниеТипОбязательно?Описание
keystringКлюч веб-API Steamworks для аутентификации издателя.
appiduint32AppID игры
namestringназвание списка лидеров, который необходимо удалить



ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!

FindOrCreateLeaderboard

POST https://partner.steam-api.com/ISteamLeaderboards/FindOrCreateLeaderboard/v2/
НазваниеТипОбязательно?Описание
keystringКлюч веб-API Steamworks для аутентификации издателя.
appiduint32AppID игры
namestringназвание списка лидеров, который необходимо создать
sortmethodstringметод сортировки для использования в списке лидеров (по умолчанию используется «по возрастанию»)
displaytypestringтип отображения списка лидеров (по умолчанию цифровой)
createifnotfoundboolЕсли true, ещё не существующий список лидеров будет создан. По умолчанию — true.
onlytrustedwritesboolЕсли true, клиенты не смогут задавать данные об очках в списках лидеров. Это сможет сделать только издатель с помощью SetLeaderboardScore (веб-API). По умолчанию — false.
onlyfriendsreadsboolЕсли true, данные списка лидеров смогут считываться только друзьями пользователя. Издатель всегда сможет прочесть все данные списка. По умолчанию — false.



Существуют предыдущие версии данного метода, которые больше официально не поддерживаются. Их по-прежнему можно использовать, однако настоятельно рекомендуется использовать самую последнюю версию.
История изменений:
  • Версия 2 - исправлена ошибка возвращения названия списка лидеров в формате XML.

ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!

GetLeaderboardEntries

GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardEntries/v1/
НазваниеТипОбязательно?Описание
keystringКлюч веб-API Steamworks для аутентификации издателя.
appiduint32AppID игры
rangestartint32начало диапазона или 0
rangeendint32конец диапазона или максимальное число записей в списке
steamiduint64SteamID, используемый для запросов данных друзей и пользователей вокруг
leaderboardidint32ID списка лидеров для просмотра
datarequestuint32типы запроса: RequestGlobal, RequestAroundUser, RequestFriends



ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!

GetLeaderboardsForGame

GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardsForGame/v2/
СтранаТипОбязательно?Описание
keystringКлюч веб-API Steamworks для аутентификации издателя.
appiduint32AppID игры



Существуют предыдущие версии данного метода, которые больше официально не поддерживаются. Их по-прежнему можно использовать, однако настоятельно рекомендуется использовать самую последнюю версию.
История изменений:
  • Версия 2 - исправлена ошибка возвращения названия списка лидеров в формате XML.

ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!

ResetLeaderboard

POST https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/
НазваниеТипОбязательно?Описание
keystringКлюч веб-API Steamworks для аутентификации издателя.
appiduint32AppID игры
leaderboardiduint32номер целевого списка, который можно получить от GetLeaderboardsForGame



ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!

SetLeaderboardScore

POST https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/v1/
НазваниеТипОбязательно?Описание
keystringКлюч веб-API Steamworks для аутентификации издателя.
appiduint32AppID игры
leaderboardiduint32номер целевого списка, который можно получить от GetLeaderboardsForGame
steamiduint64SteamID, данные об очках которого необходимо задать
scoreint32данные об очках, которые необходимо задать для этого пользователя
scoremethodstringметоды обновления данных: "KeepBest" или "ForceUpdate"
detailsrawbinaryинформация о том, как были заработаны очки (макс. 256 байтов)



ВНИМАНИЕ: этот вызов требует наличие API-ключа издателя. Поэтому этот API ОБЯЗАТЕЛЬНО вызывать с защищённого сервера и ни при каких обстоятельствах не допускать его использование клиентами!