Documentação do Steamworks
Autenticação com chaves da Web API
Alguns métodos da Web API retornam dados acessíveis publicamente e não exigem autorização quando chamados. Outros métodos podem obrigar o uso de uma chave única para a API. Há também métodos que retornam dados delicados ou realizam uma ação especial, obrigando o uso de uma chave da distribuidora, que precisa ser criada antes de usá-los. Nos casos em que é obrigatório usar uma chave da API, ela pode ser informada seja como um parâmetro-padrão ou como o valor do cabeçalho "x-webapi-key" da requisição.

Chaves de usuário

Chaves comuns de usuário estão disponíveis a todos, bastando ter uma conta Steam e o nome do domínio associado à chave.

Também será necessário aceitar os Termos de Uso da Web API do Steam.

Crie uma chave da Web API na página de criação de chaves na Comunidade Steam.

Chaves de distribuidora

Os desenvolvedores de jogos podem criar chaves da Web API associadas à sua conta de distribuidora no Steamworks. Essas chaves podem ser usadas para acessar métodos da Web API públicos e exclusivos para distribuidoras.

Cada chave de distribuidora está associada a um grupo de distribuidora no Steamworks. Para controlar o acesso concedido pela chave, os métodos da Web API exclusivos para distribuidoras usam o seguinte:
  • Associação do AppID ao grupo da distribuidora: alguns métodos exigem que o valor "appid" informado na requisição esteja associado ao grupo da distribuidora da chave.
  • Permissões da chave: todos os métodos exclusivos para distribuidoras exigem uma permissão específica, e a chave usada na requisição precisa tê-la para que a chamada seja bem-sucedida. Consulte a referência da Web API do Steamworks para determinar qual permissão é necessária para cada método.
  • Lista de endereços IP permitidos: cada chave de distribuidora pode ser associada a um conjunto de endereços IP específicos que podem usá-la.

Os quatro tipos de permissões para chaves da Web API são:
  • Microtransações para iniciar, finalizar e reconciliar compras dentro do jogo.
  • Consultas de dados de vendas pela API IPartnerFinancialService.
  • Chamadas de economia para jogos que usam o serviço de Inventário Steam.
  • Chamadas de API gerais para ações como autenticar um usuário ou verificar a titularidade de um conteúdo adicional — tudo o que não fizer parte das três primeiras permissões.

webapi_key_permissions.png
Chaves de distribuidoras para a Web API permitem acesso a dados delicados de usuários e métodos protegidos. Essas chaves devem ser usadas em requisições à Web API originadas de servidores seguros da distribuidora. As chaves devem ser armazenadas em segurança e não devem ser distribuídas com um cliente do jogo. Todas as requisições à Web API que contenham chaves devem ser feitas por HTTPS.

Criação de uma chave de distribuidora

Para criar uma chave da distribuidora para a Web API, é necessário ter permissões de administrador em uma conta do Steamworks existente. Se não for um administrador, a lista de administradores da sua conta de parceiros está disponível na coluna à direita da página de parceiro. Qualquer administrador pode criar a chave da distribuidora ou promover você a administrador.

Para criar uma chave da distribuidora para a Web API:
  1. Como um usuário com permissões de administrador na sua conta de parceiro Steamworks, acesse a lista de grupos em Usuários e permissões > Gerenciar grupos.
  2. Selecione um grupo existente ou crie um novo. Recomendamos criar um grupo dedicado para controlar o acesso de chaves da Web API usadas em jogos.
  3. Antes de criar uma chave, certifique-se de que os aplicativos associados ao grupo estejam corretos.
  4. Selecione Criar chave da Web API.
  5. Selecione o conjunto de permissões desejadas para a chave.
  6. Selecione Salvar alterações.
  7. A chave recém-criada será exibida na barra lateral direita dessa página.