Einige Web-API-Methoden geben öffentlich zugängliche Daten zurück und erfordern beim Aufrufen keine Autorisierung. Andere Methoden erfordern unter Umständen, dass Sie einen einzigartigen API-Schlüssel verwenden. Es gibt auch Methoden, die vertrauliche Daten zurückgeben oder eine geschützte Aktion durchführen und spezielle Zugriffsgenehmigungen erfordern. Diese APIs erfordern einen Publisherschlüssel, den Sie erstellen müssen, bevor Sie eine dieser APIs aufrufen. Falls ein API-Schlüssel erforderlich ist, kann dieser entweder als Standardparameter oder durch Festlegen des Anforderungsheaderwertes „x-webapi-key“ bereitgestellt werden.
Nutzerschlüssel
Der Standardnutzerschlüssel ist für jeden verfügbar; alles, was dazu erforderlich ist, ist ein Steam-Account und der Domänenname, der mit diesem Schlüssel verknüpft wird.
Außerdem müssen Sie die
Steam-Web-API-Nutzungsbedingungen akzeptieren.
Sie können einen Nutzer-Web-API-Schlüssel über die
Registrierungsseite in der Steam Community generieren.
Publisherschlüssel
Um einen Publisher sicher zu identifizieren und den Zugriff auf geschützte Methoden zu erlauben, kann ein Publisher einen Web-API-Schlüssel anfordern, der mithilfe des Schlüsselparameters an die entsprechenden Methoden übergeben werden kann. Jeder Schlüssel wird mit einer Publishergruppe verknüpft und kann dazu verwendet werden, auf Daten für alle App-IDs zuzugreifen, die ebenfalls mit dieser Gruppe verknüpft sind. Informationen zum eines Publisher-Web-API-Schlüssels finden Sie unten unter "Abrufen eines Publisherschlüssels".
Publisher-Web-API-Schlüssel stellen den Zugriff auf vertrauliche Nutzerdaten und geschützte Methoden bereit. Diese Schlüssel sind zur Verwendung für Web-API-Anfragen vorgesehen, die von gesicherten Publisherservern stammen. Diese Schlüssel müssen sicher verwahrt werden und dürfen nicht mit einem Spiel weitergegeben werden. Alle Web-API-Anfragen, die Web-API-Schlüssel enthalten, sollten über HTTPS durchgeführt werden.
Generieren eines Publisher-Web-API-Schlüssels
Zum Erstellen eines Publisher-Web-API-Schlüssels müssen Sie über Admin-Rechte innerhalb eines existierenden Steamworks-Accounts verfügen. Wenn Sie selbst kein Administrator sind, können Sie eine Liste von Administratoren für Ihren Partneraccount einsehen, indem Sie Ihre Steamworks-Startseite aufrufen und die Liste auf der rechten Seite betrachten. Jeder dieser Administratoren kann einen Publisher-Web-API-Schlüssel für Sie erstellen oder Sie zu einem Administrator machen.
So wird ein Publisher-Web-API-Schlüssel erstellt:
- Besuchen Sie als Benutzer mit Adminrechten in Ihrem Steamworks-Account zuerst Ihre Gruppenliste.
- Wählen Sie in der Liste der Gruppen eine Gruppe aus oder erstellen Sie eine Gruppe, welche die App-IDs enthält, auf die Sie mit dem Web-API-Schlüssel Zugriff erhalten sollen.
- Öffnen Sie danach diese Gruppe, um die Benutzer und Anwendungen in dieser Gruppe anzeigen zu lassen.
- Wenn Sie Admin-Rechte besitzen, sollten Sie auf der rechten Seite die Option "WebAPI-Schlüssel generieren" sehen. Falls der Schlüssel bereits generiert wurde, müssten Sie den Schlüssel aufgelistet sehen.
