qstart-soft/steam-api

PHP library for working with Steam Web API

Maintainers

Details

github.com/qstart-soft/steam-api

Source

Issues

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.1 2022-10-16 00:04 UTC

Requires

Requires (Dev)

MIT 81bdc6359d3880caee193c15d5fcc5bb1e428b02

  • Sergei Gostev <sergei.p.gostev.woop@gmail.com>

This package is auto-updated.

Last update: 2024-05-16 03:46:04 UTC

README

Qstart Steam Api library contains all the necessary set of methods for requesting Steam Web API

Installation

$ composer require qstart-soft/steam-api

Getting Started

There are two ways to submit a request.

  1. Using a PSR-18 client instance
  2. On your own using your favorite library to send HTTP requests

First of all, we need to define the method for the request and create an instance of the method.

Each method for the api in the library is a class with properties-arguments.

First way

Let's send a request using the PSR-18 client:

use Qstart\SteamApi\SteamApiKey;
use Qstart\SteamApi\SteamApi;
use Qstart\SteamApi\Method\SteamApiGetOwnedGamesV1Method;

/** @var Psr\Http\Client\ClientInterface $client */

$key = new SteamApiKey('XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');

$steamApi = new SteamApi($key, $client);

$method = new SteamApiGetOwnedGamesV1Method();
$method
    ->setSteamId(76561198072113884)
    ->setIncludeAppInfo(true)
    ->setIncludePlayedFreeGames(true)
    ->setAppIdsFilter([552990]);

/** @var \Psr\Http\Message\ResponseInterface $response */
$response = $steamApi->send($method);

// Json response from API
$json = $response->getBody()->getContents();
$data = json_encode($json, true);

Second way

Now consider the option with self-sending, without using PHP Standards Recommendations (PSR)

use Qstart\SteamApi\SteamApiKey;
use Qstart\SteamApi\SteamApiRequest;
use Qstart\SteamApi\Method\SteamApiGetOwnedGamesV1Method;

$key = new SteamApiKey('XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX');
$method = new SteamApiGetOwnedGamesV1Method();
$method
    ->setSteamId(76561198072113884)
    ->setIncludeAppInfo(true)
    ->setIncludePlayedFreeGames(true)
    ->setAppIdsFilter([552990]);

$request = new SteamApiRequest($method, $key);

$link = $request->getUri();
$arguments = $request->getPreparedArguments();
$psr7Request = $request->getPsr7Request();

// Further, for example, if you want to get a link for a get request
$uri = $link . '?' . http_build_query($arguments);

Formats

In order to change the format of the response, you must call the setter of the method instance

use Qstart\SteamApi\SteamApiFormats;
use Qstart\SteamApi\Method\SteamApiGetOwnedGamesV1Method;

$method = new SteamApiGetOwnedGamesV1Method();
$method->setFormat(SteamApiFormats::VDF);

Wonderful!

Resources