Används för att komma åt information och interagera med användare.

Se IPlayerService för ytterligare metoder.

Läs Web API Overview för mer information om hur man använder Steamworks webb-API.

CheckAppOwnership

Namn	Typ	Krävs	Beskrivning
key	string	✔	Utgivarautentiseringsnyckel för Steamworks webb-API.
steamid	uint64	✔	Användarens Steam-ID.
appid	uint32	✔	App-ID för att kontrollera ägarskap.

Kontrollerar om den angivna användaren äger appen.

JSON-svaret kommer att innehålla följande fält:

Namn	Typ	Beskrivning
ownsapp	bool	Anger om användaren är den faktiska ägaren av appen.
permanent	bool	Om användaren permanent äger din app. Gäller inte för ägande via familjedelning, gratishelger eller internetkaféprogram.
timestamp	string	Tidpunkten då appen förvärvades.
ownersteamid	uint64	Indikerar den faktiska ägaren om användaren använder appen via familjedelning. Annars skickas samma Steam-ID.
sitelicense	bool	Indikerar om användaren använder appen via internetkaféprogrammet.

Denna metod har tidigare versioner som inte längre stöds officiellt. De kan användas även fortsättningsvis, men det rekommenderas starkt att du använder den senaste versionen.
Ändringshistorik:

• Version 2 – lägger till elementet sitelicense till svaret.

OBS: Anropet kräver API-utgivarnyckeln som äger det angivna app-ID:t för att metoden ska kunna användas. Därför MÅSTE API:et anropas från en säker server och kan aldrig användas direkt av klienter!

GetAppPriceInfo

Namn	Typ	Krävs	Beskrivning
key	string	✔	Utgivarautentiseringsnyckel för Steamworks webb-API.
steamid	uint64	✔	Användarens Steam-ID.
appids	string	✔	Kommaavgränsad lista med app-ID:n (max: 100).

OBS: Anropet kräver en API-utgivarnyckel för att kunna använda denna metod. Därför MÅSTE detta API anropas från en säker server och kan aldrig användas direkt av klienter!

Exempel på svar:

GetDeletedSteamIDs

Namn	Typ	Krävs	Beskrivning
key	string	✔	Utgivarautentiseringsnyckel för Steamworks webb-API.
rowversion	uint64	✔	Ett osignerat 64-bitars värde som används för att bläddra igenom borttagna konton. Skicka 0 när du anropar API:et för första gången. Skicka sedan det värde som returnerades från det tidigare anropet för varje ytterligare begäran. Värdet måste lagras på din server för framtida anrop.

Du kan använda GetDeletedSteamIDs för att hämta en lista över raderade konton som ägde ditt/dina spel före raderingen. Detta API skapades för att möjliggöra radering av användarrelaterade data för dataskyddsförordningen (GDPR) och andra persondataändamål.

Den medföljande Steamworks-utgivarnyckeln används både för autentisering och generering av listan med app-ID:n att kontrollera mot.

GetFriendList

Namn	Typ	Krävs	Beskrivning
key	string	✔	Användarautentiseringsnyckel för Steamworks webb-API.
steamid	uint64	✔	Användarens Steam-ID.
relationship	string		relationstyp (t ex: vän).

GetPlayerBans

Namn	Typ	Krävs	Beskrivning
key	string	✔	Användarautentiseringsnyckel för Steamworks webb-API.
steamids	string	✔	Kommaavgränsad lista med Steam-ID:n.

GetPlayerSummaries

Namn	Typ	Krävs	Beskrivning
key	string	✔	Användarautentiseringsnyckel för Steamworks webb-API.
steamids	string	✔	Kommaavgränsad lista med Steam-ID:n (max: 100).

OBS: Detta anrop bör endast användas om webbplatsen behöver visa information om en användare. Om spelklienten behöver någon av denna information ska du använda klientens API:er istället.

Denna metod har tidigare versioner som inte längre stöds officiellt. De kan användas även fortsättningsvis, men det rekommenderas starkt att du använder den senaste versionen.
Ändringshistorik:

• Version 2 – tar bort elementnamn från fält.

Svaret från anropet kommer att se ut ungefär så här:

GetPublisherAppOwnership

Namn	Typ	Krävs	Beskrivning
key	string	✔	Utgivarautentiseringsnyckel för Steamworks webb-API.
steamid	uint64	✔	Användarens Steam-ID.

Denna metod har tidigare versioner som inte längre stöds officiellt. De kan användas även fortsättningsvis, men det rekommenderas starkt att du använder den senaste versionen.
Ändringshistorik:

• Version 3 – lägger till element sitelicense till svaret.

Svaret från anropet kommer att se ut ungefär så här:


JSON-svaret kommer att innehålla följande fält:

Namn	Typ	Beskrivning
appid	uint32	App-ID associerat med din webb-API-nyckel.
ownsapp	bool	Om användaren för närvarande äger din app. Gäller inte för ägande via köp, cd-nycklar, familjedelning, gratishelger eller internetkaféprogram.
permanent	bool	Om användaren permanent äger din app. Gäller inte för ägande via familjedelning, gratishelger eller internetkaféprogram.
timestamp	string	GMT-tid när användaren skaffade app-ID:t.
ownersteamid	uint64	Indikerar den faktiska ägaren om användaren använder appen via familjedelning. Annars skickas samma Steam-ID.
sitelicense	bool	Indikerar om användaren använder den här appen via internetkaféprogrammet.

OBS: Anropet kräver en API-utgivarnyckel för att kunna använda denna metod. Därför MÅSTE detta API anropas från en säker server och kan aldrig användas direkt av klienter!

GetPublisherAppOwnershipChanges

Namn	Typ	Krävs	Beskrivning
key	string	✔	Utgivarautentiseringsnyckel för Steamworks webb-API.
packagerowversion	string	✔	Den osignerade 64-bitars radversionen för läsning av paketändringar. Radversionen av data som läses returneras för användning i framtida anrop.
cdkeyrowversion	string	✔	Den osignerade 64-bitars radversionen för läsning av cd-nyckeländringar. Radversionen av data som läses returneras för användning i framtida anrop.

Denna metod kan användas för att avgöra vilka Steam-ID:n som har ägandeändringar med början från ett visst pakets eller en nyckelrads versionsnummer. Från listan över Steam-ID:n som returneras kan ett anrop till GetPublisherAppOwnership sedan returnera tillhörande ägardata för applikationerna i gruppen som är kopplade till nyckeln som skickas in. En partner kanske vill spåra dessa data i samband med länkade Steam-konton för att bättre förstå tillståndet för produktägande på Steam.

Inled med att anropa GetPublisherAppOwnershipChanges och skicka in packagerowversion och cdkeyrowversion med värdena 0 (noll). Svaret från anropet kommer att se ut ungefär så här:


JSON-svaret kommer att innehålla följande fält:

Namn	Typ	Beskrivning
steamids/steamid	string	Listan med Steam-ID:n för alla konton som har ändrats sedan de tillhandahållna radversionerna. Upp till 10 000 Steam-ID:n kommer att returneras per anrop.
packagerowversion	string	Paketradsversionen som matchar det senaste Steam-ID:t som returnerades. Spara detta för framtida anrop till getPublisherAppOwnershipChanges.
cdkeyrowversion	string	Cd-nyckelradsversionen som matchar det senaste Steam-ID:t som returnerades. Spara detta för framtida anrop till getPublisherAppOwnershipChanges.
moredata	bool	Indikerar om fler och nyare data finns tillgängliga.

Efter det första anropet returneras:

1. Anropa GetPublisherAppOwnership för varje Steam-ID för att få det faktiska ägandet per app-ID. Spara eller använd dessa uppgifter efter behov.
   
2. När alla SteamID:n har bearbetats, kontrollera värdet på moredata. Om true, anropa GetPublisherAppOwnershipChangespå nytt och skicka packagerowversion och cdkeyrowversion som returnerades vid det föregående anropet tillGetPublisherAppOwnershipChanges.
   
3. Upprepa steg 1 och 2 tills moredata returnerar false.
   
4. Lagra de slutliga värdena för packagerowversion och cdkeyrowversion för användning i framtida GetPublisherAppOwnershipChanges anrop (t.ex. 24 timmar senare) istället för att börja på 0 (noll) igen.

OBS: Anropet kräver en API-utgivarnyckel för att kunna använda denna metod. Därför MÅSTE detta API anropas från en säker server och kan aldrig användas direkt av klienter!

GetUserGroupList

Namn	Typ	Krävs	Beskrivning
key	string	✔	Utgivarautentiseringsnyckel för Steamworks webb-API.
steamid	uint64	✔	Användarens Steam-ID.

ResolveVanityURL

Namn	Typ	Krävs	Beskrivning
key	string	✔	Användarautentiseringsnyckel för Steamworks webb-API.
vanityurl	string	✔	Den anpassade webbaddressen till vilken ett Steam-ID ska hämtas.
url_type	int32		Typ av anpassad webbadress. 1 (standard): individuell profil, 2: grupp, 3: officiell spelgrupp