Steam¶
The Steam modules allow you to list the recently played games, new games, and news for the steam app in your Steam account.
Getting Started with Steam¶
Prerequisites
- A Steam account
In order to use Steam with Ibexa Connect, it is necessary to have a Steam account. If you do not have one, you can create a Steam account at store.steampowered.com.
Note
The module dialog fields that are displayed in bold (in the Ibexa Connect scenario, not in this documentation article) are mandatory!
Connecting Steam to Ibexa Connect¶
To connect your Steam account to Ibexa Connect you need to obtain the API Key from your Steam account and insert it in the Create a connection dialog in the Ibexa Connect module.
1. Go to the Steam API Key page and log in to your Steam account.
2. Copy the API Key to your clipboard.
You must have games in your account to enable the API key.
3. Go to Ibexa Connect and open the Steam module's Create a Connection dialog.
4. In the Connection name field, enter a name for the connection.
5. In the API Key field, enter the API Key copied in step 2, and click Continue.
Note
Steam does not provide a method to verify the API key. Ensure to double-check that the entered API key is correct.
The connection has been established.
Games¶
List Owned Games¶
Gets a list of owned games by Profile ID.
| Steam ID | Enter (map) the Steam ID whose games you want to list. Your Steam is an integer and can be found at Your Profile Icon > Accounts. |
| Include App Info | Select whether you want to include the game name and logo information in the results. |
| Include Played Free Games | Select whether you want to include the free games played by the user. |
| Apps ID Filter | Enter the App ID to list the games related to the specified App ID. |
| Limit | Set the maximum number of owned games Ibexa Connect should return during one execution cycle. |
List Recently Played Games¶
Gets a list of recently played games of two weeks on a specified account.
| Steam ID | Enter (map) the Steam ID whose recently played games you want to list. Your Steam is an integer and can be found at Your Profile Icon > Accounts. |
| Limit | Set the maximum number of played games Ibexa Connect should return during one execution cycle. |
List News for App¶
Gets all news about the specified app.
| Steam ID | Enter (map) the Steam ID whose games you want to list. Your Steam is an integer and can be found at Your Profile Icon > Accounts. |
| Include App Info | Select whether you want to include the game name and logo information in the results. |
| Include Played Free Games | Select whether you want to include the free games played by the user. |
| Apps ID Filter | Enter the App ID to list the games related to the specified App ID. |
| Limit | Set the maximum number of news items Ibexa Connect should return during one execution cycle. |
Other¶
Make an API Call¶
Performs an arbitrary authorized API call.
URL |
Enter a path relative to | For the list of available endpoints, refer to the Steam API Documentation. |
Method
Select the HTTP method you want to use:
GET to retrieve information for an entry.
POST to create a new entry.
PUT to update/replace an existing entry.
PATCH to make a partial entry update.
DELETE to delete an entry.
Headers
Enter the desired request headers. You don't have to add authorization headers; we already did that for you.
Query String
Enter the request query string.
Body
Enter the body content for your API call.
Example of Use - Get News for App¶
The following API call returns all the news items for the specified app from your Steam account:
URL: /ISteamNews/GetNewsForApp/v0002
Method: GET
Matches of the search can be found in the module's Output under Bundle > Body > newsitems. In our example, 152 news items were returned:
