Usada para acessar tabelas de classificações Steam.
Para mais informações sobre como usar a Web API do Steamworks, consulte a
Visão geral da Web API.
DeleteLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/
| Nome | Tipo | Obrigatório | Descrição |
|---|
| key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
| appid | uint32 | ✔ | O AppID do jogo. |
| name | string | ✔ | Nome da tabela a excluir. |
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
FindOrCreateLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/FindOrCreateLeaderboard/v2/
| Nome | Tipo | Obrigatório | Descrição |
|---|
| key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
| appid | uint32 | ✔ | O AppID do jogo. |
| name | string | ✔ | Nome da tabela a buscar ou criar. |
| sortmethod | string | | Forma de ordenação da tabela (padrão: "Ascending" — crescente). |
| displaytype | string | | Forma de exibição da tabela (padrão: "Numeric" — numérico). |
| createifnotfound | bool | | Se true, a tabela será criada se não existir. Padrão: true. |
| onlytrustedwrites | bool | | Se true, as pontuações da tabela não poderão ser definidas por clientes, apenas pela distribuidora com a Web API SetLeaderboardScore. Padrão: false. |
| onlyfriendsreads | bool | | Se true, as tabelas só poderão ser lidas por amigos e pela distribuidora. Padrão: false. |
As versões antigas deste método estão em processo de desuso. Elas continuarão funcionando, mas é recomendado que use a versão mais recente.
Histórico de versões:
- Versão 2 — Correção do retorno do nome da tabela em XML.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
GetLeaderboardEntries
GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardEntries/v1/
| Nome | Tipo | Obrigatório | Descrição |
|---|
| key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
| appid | uint32 | ✔ | O AppID do jogo. |
| rangestart | int32 | ✔ | Início do intervalo ou 0. |
| rangeend | int32 | ✔ | Fim do intervalo ou máximo de entradas na tabela. |
| steamid | uint64 | | O ID Steam usado para requisições de amigos e proximidade. |
| leaderboardid | int32 | ✔ | O ID da tabela a visualizar. |
| datarequest | uint32 | ✔ | O tipo da requisição: RequestGlobal, RequestAroundUser, RequestFriends. |
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
GetLeaderboardsForGame
GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardsForGame/v2/
| Nome | Tipo | Obrigatório | Descrição |
|---|
| key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
| appid | uint32 | ✔ | O AppID do jogo. |
As versões antigas deste método estão em processo de desuso. Elas continuarão funcionando, mas é recomendado que use a versão mais recente.
Histórico de versões:
- Versão 2 — Correção do retorno do nome da tabela em XML.
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
ResetLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/
| Nome | Tipo | Obrigatório | Descrição |
|---|
| key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
| appid | uint32 | ✔ | O AppID do jogo. |
| leaderboardid | uint32 | ✔ | O ID numérico da tabela-alvo. Esse ID pode ser recuperado pelo método GetLeaderboardsForGame. |
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
SetLeaderboardScore
POST https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/v1/
| Nome | Tipo | Obrigatório | Descrição |
|---|
| key | string | ✔ | Chave de autenticação da distribuidora para a Web API do Steamworks. |
| appid | uint32 | ✔ | O AppID do jogo. |
| leaderboardid | uint32 | ✔ | O ID numérico da tabela-alvo. Esse ID pode ser recuperado pelo método GetLeaderboardsForGame. |
| steamid | uint64 | ✔ | O ID Steam cuja pontuação definir. |
| score | int32 | ✔ | A pontuação a definir para o ID Steam informado. |
| scoremethod | string | ✔ | Forma de atualização a usar: "KeepBest" (manter melhor pontuação) ou "ForceUpdate" (forçar atualização). |
| details | rawbinary | | Detalhes específicos do jogo sobre como a pontuação foi obtida. Até 256 bytes. |
AVISO: este método requer uma chave da distribuidora. Por isso, a API
DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!
