Documentação do Steamworks
Interface ISteamUser
Usada para acesso a dados e interação com usuários.

Consulte IPlayerService para métodos adicionais.

Para mais informações sobre como usar a Web API do Steamworks, consulte a Visão geral da Web API.

CheckAppOwnership

GET https://partner.steam-api.com/ISteamUser/CheckAppOwnership/v2/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
steamiduint64O ID Steam do usuário.
appiduint32AppID para verificação de titularidade.

Verifica se o usuário especificado possui o aplicativo informado.

A resposta JSON conterá os campos:

NomeTipoDescrição
ownsappboolIndica se o usuário é o titular do aplicativo.
permanentboolIndica se o usuário possui o aplicativo de forma permanente. Retorna false caso o possua por meio de compartilhamento de biblioteca, obtenção em fim de semana gratuito ou programa de cyber cafés.
timestampstringHorário de aquisição do aplicativo.
ownersteamiduint64Indica o verdadeiro titular se o usuário estiver acessando este aplicativo por meio do compartilhamento de biblioteca. Caso contrário, o ID Steam do usuário será retornado.
sitelicenseboolIndica se o usuário está acessando este aplicativo por meio do programa de cyber cafés.

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 — Adição do elemento sitelicense à resposta.

AVISO: este método requer uma chave da distribuidora proprietária do AppID especificado. Por isso, a API DEVE ser chamada a partir de um servidor seguro, nunca a partir de clientes!

GetAppPriceInfo

GET https://partner.steam-api.com/ISteamUser/GetAppPriceInfo/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
steamiduint64O ID Steam do usuário.
appidsstringLista separada por vírgulas de AppIDs (máximo: 100).

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!

Example Response:
{ "price_info": { "220": { "packageid": 36, "currency": "USD", "initial_price": 999, "final_price": 999, "discount_percent": 0 } } }

GetDeletedSteamIDs

GET https://partner.steam-api.com/ISteamUser/GetDeletedSteamIDs/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
rowversionuint64Um valor sem sinal de 64 bits usado para analisar contas excluídas. Passe o valor 0 ao chamar esta API pela primeira vez e depois passe o valor retornado pela chamada anterior para cada requisição adicional. Esse valor deverá ser armazenado no servidor para chamadas futuras.

Você pode usar a função GetDeletedSteamIDs para recuperar uma lista de contas excluídas que possuíam jogos seus antes da exclusão. Esta API foi criada para permitir a exclusão de dados relativos ao usuário para o Regulamento Geral sobre a Proteção de Dados da União Europeia (RGPD) e outros fins relativos a dados pessoais.

A Chave da distribuidora do Steamworks informada é usada para autenticação e para gerar a lista de AppIDs para verificação.

GetFriendList

GET https://partner.steam-api.com/ISteamUser/GetFriendList/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação do usuário para a Web API do Steamworks.
steamiduint64O ID Steam do usuário.
relationshipstringTipo de relacionamento (ex.: amigo).

GetPlayerBans

GET https://partner.steam-api.com/ISteamUser/GetPlayerBans/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação do usuário para a Web API do Steamworks.
steamidsstringLista separada por vírgulas de IDs Steam

GetPlayerSummaries

GET https://partner.steam-api.com/ISteamUser/GetPlayerSummaries/v2/
NomeTipoObrigatórioDescrição
keystringChave de autenticação do usuário para a Web API do Steamworks.
steamidsstringLista separada por vírgulas de IDs Steam (máximo: 100).

AVISO: This call should only be used if your website needs to display information about a user. If your game client needs any of this information, please use the client APIs instead.

This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:
  • Versão 2 — Remove nomes de elementos de vetores

The response from the call will look something like this:

"response":{ "players":[ { "steamid":"77561198355051011", "communityvisibilitystate":1, "profilestate":1, "personaname":"Mister Manager", "lastlogoff":1556305001, "profileurl":"https://steamcommunity.com/profiles/77561198355051011/", "avatar":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/32/32f70a383a437d03af91d2f01a0776adf75201b5.jpg", "avatarmedium":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/32/32f70a383a437d03af91d2f01a0776adf75201b5_medium.jpg", "avatarfull":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/32/32f70a383a437d03af91d2f01a0776adf75201b5_full.jpg", }, { "steamid":"77561197978236369", "communityvisibilitystate":3, "profilestate":1, "personaname":"Olive The Dog", "lastlogoff":1556239336, "profileurl":"https://steamcommunity.com/id/olive_the_dog/", "avatar":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/41/555d2fbb879593c0565ce0489428a09c019feffa.jpg", "avatarmedium":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/41/555d2fbb879593c0565ce0489428a09c019feffa_medium.jpg", "avatarfull":"https://steamcdn-a.akamaihd.net/steamcommunity/public/images/avatars/41/555d2fbb879593c0565ce0489428a09c019feffa_full.jpg", } ] }

GetPublisherAppOwnership

GET https://partner.steam-api.com/ISteamUser/GetPublisherAppOwnership/v3/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
steamiduint64O ID Steam do usuário.


This method has previous versions which are no longer officially supported. They will continue to be usable but it's highly recommended that you use the latest version.
Change history:
  • Versão 3 — Adição do elemento sitelicense à resposta

The response from the call will look something like this:

"appownership":{ "apps":[ { "appid":60, "ownsapp":true, "permanent":true, "timestamp":"2005-04-03T17:50:29Z", "ownersteamid":"76561197978236369", "sitelicense":"false" }, { "appid":220, "ownsapp":false, "permanent":false, "timestamp":"NIL", "ownersteamid":"0", "sitelicense":"true" } ] }

The JSON response will contain the following fields:

NomeTipoDescrição
appiduint32O AppID associado à chave da WebAPI.
ownsappboolIndica se o usuário possui o aplicativo atualmente. Retorna true caso o possua por meio de compra no Steam, ativação de código de produto, compartilhamento de biblioteca, obtenção em fim de semana gratuito ou programa de cyber cafés.
permanentboolIndica se o usuário possui o aplicativo de forma permanente. Retorna false caso o possua por meio de compartilhamento de biblioteca, obtenção em fim de semana gratuito ou programa de cyber cafés.
timestampstringData completa, no fuso horário GMT, de quando o usuário adquiriu o AppID pela primeira vez.
ownersteamiduint64Indica o verdadeiro titular se o usuário estiver acessando este aplicativo por meio do compartilhamento de biblioteca. Caso contrário, o ID Steam do usuário será retornado.
sitelicenseboolIndica se o usuário está acessando este aplicativo por meio do programa de cyber cafés.

AVISO: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetPublisherAppOwnershipChanges

GET https://partner.steam-api.com/ISteamUser/GetPublisherAppOwnershipChanges/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
packagerowversionstringA versão de linha sem sinal de 64 bits para ler mudanças de pacotes. A versão de linha da leitura dos dados será retornada para uso em chamadas futuras.
cdkeyrowversionstringA versão de linha sem sinal de 64 bits para ler mudanças de código de produto. A versão de linha da leitura dos dados será retornada para uso em chamadas futuras.

This method can be used to determine what SteamIDs have ownership changes starting from a particular package or key row version number. From the list of SteamIDs returned, a call to GetPublisherAppOwnership can then return the associated ownership data for the applications in the group associated with the key passed in. A partner may wish to track this data in conjunction with linked Steam Accounts to better understand the state of product ownership on Steam.

To begin, make a call to GetPublisherAppOwnershipChanges passing in packagerowversion and cdkeyrowversion with the values of 0 (zero). The response from the call will look something like this:

"ownershipchanges": { "steamids": [ { "steamid": "76561198114498811" }, { "steamid": "76561198114498812" }, ... ], "packagerowversion": "12448390228", "cdkeyrowversion": "49857241147", "moredata": true }

The JSON response will contain the following fields:

NomeTipoDescrição
steamids/steamidstringA lista de IDs Steam das contas alteradas desde as versões de linha fornecidas. Até 10 mil IDs Steam serão retornados por chamada.
packagerowversionstringA versão de linha de pacote que corresponde ao último ID Steam retornado. Armazene esse dado para chamadas futuras ao método GetPublisherAppOwnershipChanges.
cdkeyrowversionstringA versão de linha do código de produto que corresponde ao último ID Steam retornado. Armazene esse dado para chamadas futuras ao método GetPublisherAppOwnershipChanges.
moredataboolIndica se novos dados estão disponíveis.

After this first call returns:
  1. Realize uma chamada ao método GetPublisherAppOwnership para cada ID Steam para recuperar os dados de titularidade por AppID. Armazene ou use os dados conforme necessário;
  2. Depois que todos os IDs Steam forem processados, verifique o valor de moredata. Se for true, realize uma nova chamada ao método GetPublisherAppOwnershipChanges, passando os valores packagerowversion e cdkeyrowversion retornados da última chamada ao método GetPublisherAppOwnershipChanges;
  3. Repita os passos 1 e 2 até moredata retornar false;
  4. Armazene os valores packagerowversion e cdkeyrowversion da última chamada para uso em chamadas futuras ao método GetPublisherAppOwnershipChanges (ex.: 24 horas depois), em vez de começar em 0 (zero) de novo.

NOTE: This call requires a publisher API key to use this method. As such this API MUST be called from a secure server, and can never be used directly by clients!

GetUserGroupList

GET https://partner.steam-api.com/ISteamUser/GetUserGroupList/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação da distribuidora para a Web API do Steamworks.
steamiduint64O ID Steam do usuário.

ResolveVanityURL

GET https://partner.steam-api.com/ISteamUser/ResolveVanityURL/v1/
NomeTipoObrigatórioDescrição
keystringChave de autenticação do usuário para a Web API do Steamworks.
vanityurlstringO URL personalizado cujo ID Steam recuperar.
url_typeint32O tipo de URL personalizado. 1 (padrão): perfil individual. 2: grupo. 3: grupo oficial de jogo.