Utilizzata per accedere alle classifiche di Steam.
Per ulteriori informazioni sull'API web di Steamworks, consulta la seguente documentazione:
Panoramica sull'API web.
DeleteLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/DeleteLeaderboard/v1/
| Nome | Tipo | Necessario | Descrizione |
|---|
| key | string | ✔ | Chiave di autenticazione dell'editore per l'API web di Steamworks. |
| appid | uint32 | ✔ | L'appID del gioco |
| name | string | ✔ | Nome della classifica da eliminare |
NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API
DEVE arrivare da un server protetto e non può mai essere effettuata dai client!
FindOrCreateLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/FindOrCreateLeaderboard/v2/
| Nome | Tipo | Necessario | Descrizione |
|---|
| key | string | ✔ | Chiave di autenticazione dell'editore per l'API web di Steamworks. |
| appid | uint32 | ✔ | L'appID del gioco |
| name | string | ✔ | Nome della classifica da creare |
| sortmethod | string | | Metodo con cui la classifica è ordinata (ascendente per impostazione predefinita) |
| displaytype | string | | Tipo di visualizzazione per questa classifica (numerico per impostazione predefinita) |
| createifnotfound | bool | | Se "true", la classifica verrà creata se non esiste già. Impostazione predefinita: true. |
| onlytrustedwrites | bool | | Se "true", i punteggi della classifica non possono venire impostati dai client, ma solo dagli editori attraverso l'API web SetLeaderboardScore. Valore predefinito: false. |
| onlyfriendsreads | bool | | Se "true", il client può mostrare i risultati della classifica solo agli amici. Gli editori possono sempre vedere i risultati. Valore predefinito: false. |
Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
- Versione 2 - Corregge la restituzione della classifica in XML.
NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API
DEVE arrivare da un server protetto e non può mai essere effettuata dai client!
GetLeaderboardEntries
GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardEntries/v1/
| Nome | Tipo | Necessario | Descrizione |
|---|
| key | string | ✔ | Chiave di autenticazione dell'editore per l'API web di Steamworks. |
| appid | uint32 | ✔ | L'appID del gioco |
| rangestart | int32 | ✔ | Inizio dell'intervallo oppure 0 |
| rangeend | int32 | ✔ | Fine dell'intervallo o massimo numero di voci nella classifica |
| steamid | uint64 | | ID di Steam utilizzato per gli amici e le richieste dell'utente |
| leaderboardid | int32 | ✔ | ID della classifica da visualizzare |
| datarequest | uint32 | ✔ | Tipo di richiesta: RequestGlobal, RequestAroundUser, RequestFriends |
NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API
DEVE arrivare da un server protetto e non può mai essere effettuata dai client!
GetLeaderboardsForGame
GET https://partner.steam-api.com/ISteamLeaderboards/GetLeaderboardsForGame/v2/
| Nome | Tipo | Necessario | Descrizione |
|---|
| key | string | ✔ | Chiave di autenticazione dell'editore per l'API web di Steamworks. |
| appid | uint32 | ✔ | L'appID del gioco |
Questo metodo ha delle versioni precedenti che non sono più ufficialmente supportate. Potrai continuare a usarle, ma ti consigliamo vivamente di utilizzare la versione più recente.
Cronologia delle modifiche:
- Versione 2 - Corregge la restituzione della classifica in XML.
NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API
DEVE arrivare da un server protetto e non può mai essere effettuata dai client!
ResetLeaderboard
POST https://partner.steam-api.com/ISteamLeaderboards/ResetLeaderboard/v1/
| Nome | Tipo | Necessario | Descrizione |
|---|
| key | string | ✔ | Chiave di autenticazione dell'editore per l'API web di Steamworks. |
| appid | uint32 | ✔ | L'appID del gioco |
| leaderboardid | uint32 | ✔ | ID numerico della classifica interessata. Ottenibile tramite GetLeaderboardsForGame |
NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API
DEVE arrivare da un server protetto e non può mai essere effettuata dai client!
SetLeaderboardScore
POST https://partner.steam-api.com/ISteamLeaderboards/SetLeaderboardScore/v1/
| Nome | Tipo | Necessario | Descrizione |
|---|
| key | string | ✔ | Chiave di autenticazione dell'editore per l'API web di Steamworks. |
| appid | uint32 | ✔ | L'appID del gioco |
| leaderboardid | uint32 | ✔ | ID numerico della classifica interessata. Ottenibile tramite GetLeaderboardsForGame |
| steamid | uint64 | ✔ | Id di Steam per cui impostare il punteggio |
| score | int32 | ✔ | Il punteggio da impostare per questo utente |
| scoremethod | string | ✔ | Metodo di aggiornamento da utilizzare. Può essere "KeepBest" o "ForceUpdate" |
| details | rawbinary | | Dettagli, specifici del gioco, su come è stato ottenuto il punteggio. Fino a 256 byte. |
NOTA: per questo metodo, la chiamata richiede una chiave API da editore. La chiamata API
DEVE arrivare da un server protetto e non può mai essere effettuata dai client!
