Dokumentace systému Steamworks
Ověření pomocí klíčů webových API
Zatímco některé metody webových API vrací veřejně dostupná data a při volání nevyžadují ověření, jiné metody mohou vyžadovat unikátní klíč. A pak existují metody, které vrací citlivá data nebo provádí chráněné akce a vyžadují speciální oprávnění. Před zavoláním posledních zmiňovaných metod je tedy nutné nejprve vytvořit vydavatelský klíč a ten poskytnout buďto jako standardní parametr, nebo nastavením hodnoty „x-webapi-key“ v hlavičce volání.

Uživatelské klíče

Standardní uživatelské klíče jsou dostupné pro všechny a pro jejich vytvoření stačí účet služby Steam a název domény, která bude ke klíči přiřazena.

Plus je nutné vyjádřit souhlas s Podmínkami použití webových API služby Steam.

Uživatelský klíč webových API si můžete vytvořit na této stránce.

Vydavatelské klíče

Vývojáři/vydavatelé si mohou vytvořit klíče webových API, které budou přiřazeny k jejich účtu partnera systému Steamworks. Tyto klíče lze použít jak pro přístup k veřejným metodám webových API, tak pro přístup k metodám webových API pouze pro vydavatele.

Konkrétně je každý vydavatelský klíč přiřazený ke skupině v rámci partnera systému Steamworks a metody pouze pro vydavatele mohou být dále omezeny:
  • ID aplikace – Některé metody pouze pro vydavatele vyžadují, aby byla hodnota ID aplikace poskytnutá ve volání přiřazena ke skupině daného klíče.
  • Oprávnění klíče – Každá metoda pouze pro vydavatele spadá do určité skupiny, pro kterou musí mít klíč volání oprávnění. To, do které skupiny spadají jednotlivé metody, se dozvíte na stránce Reference webových API.
  • Povolené IP adresy – Každý vydavatelský klíč může být také omezen na určitou sadu volajících IP adres.

Skupiny metod, k nimž lze klíčům povolit, nebo naopak zakázat přístup, jsou následující:
  • Mikrotransakce (inicializace, finalizace a urovnání nákupů ve hrách)
  • Finance (volání API IPartnerFinancialService)
  • Ekonomika (pro hry využívající funkci Inventář)
  • Obecné metody (metody, které nespadají do předchozích skupin, např. ověření uživatele nebo vlastnictví DLC)

Oprávnění klíče webových API
Vydavatelské klíče webových API poskytují přístup k citlivým uživatelským datům a chráněným metodám. Tyto klíče jsou určeny pro použití s voláními, která pochází ze zabezpečených vydavatelských serverů. Tyto klíče musí být uloženy na bezpečném místě a nesmí být distribuovány s herním klientem. Všechna volání webových API zahrnující klíč by měla být prováděna přes HTTPS.

Vytvoření vydavatelského klíče

Pro vytvoření vydavatelského klíče webových API musíte v rámci stávajícího účtu partnera systému Steamworks disponovat oprávněními správce. Pokud nejste sami správci, můžete v pravé části domovské stránky systému Steamworks vidět seznam správců, pod které spadáte. Kterýkoli z těchto správců pro Vás může vytvořit vydavatelský klíč, nebo Vás případně povýšit na správce.

Pro vytvoření samotného klíče postupujte následovně:
  1. Pokud disponujete oprávněními správce, přejděte do Uživatelé a oprávnění > Správa skupin.
  2. Vyberte stávající skupinu, nebo vytvořte novou. Pro snazší správu oprávnění klíče webových API doporučujeme vytvořit specializovanou skupinu.
  3. Před vytvořením klíče se ujistěte, že jsou ke skupině přiřazeny správné aplikace.
  4. Klikněte na Vytvořit klíč webových API.
  5. Vyberte skupiny metod, ke kterým má klíč mít přístup.
  6. Klikněte na Uložit změny.
  7. Nově vytvořený klíč se zobrazí po pravé straně.