Download the PHP package zyberspace/steam-web-api-client without Composer
On this page you can find all versions of the php package zyberspace/steam-web-api-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download zyberspace/steam-web-api-client
More information about zyberspace/steam-web-api-client
Files in zyberspace/steam-web-api-client
Package steam-web-api-client
Short Description Automatically generated api client for the Steam Web API in style of the google-api-php-client.
License MPL-2.0
Homepage https://github.com/zyberspace/php-steam-web-api-client
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package steam-web-api-client
zyberspace/steam-web-api-client
Automatically generated api client for the Steam Web API in style of the google-api-php-client.
Automatically generated?
Yeah, every API interface (those are not php interfaces) got generated automatically from the /ISteamWebAPIUtil/GetSupportedAPIList/v1/ method. Only the classes outside of the Interfaces directory are written from hand.
This way it is easy for me to keep the api updated because i just need to run the generation command every time valve changes something.
Installation
In your project-root:
Composer will then automatically add the package to your project requirements and install it (also creates the composer.json if you don't have one already).
Client structure
The client is structured in 3 peaces:
- The
Clientclass which saves your api key and takes care of the actual api calls. - The api interfaces which are automatically generated and provide the api methods to call.
- The
InterfaceGeneratorwhich generated the interfaces. You don't need this one except you want to update the saved interface classes.
(Use it by installing the dev dependencies and the executecomposer generate-interfaces [your api key].)
Quickstart
If you installed the client with composer like above and already obtained your api key from valve these are the 4 steps to use the api:
-
Require the composer autoloader
-
Create the Steam Web API Client
-
Create an instance of the api interface you want to use
- Make your call to the method you want to use
Every method returns an object build from the json response. If you want to know more about the response format of every specific method, check the Steam Web API documentation.
Working with multiple optional arguments
If the method you need has multiple optional arguments but you don't want to use all of them, set the non-needed arguments to null. This is also the default value for them and will therefore be ignored by the client.
Documentation
To create the docs, just run phpdoc in the the project-root.
An online-version is available at phpdoc.zyberware.org/zyberspace/steam-web-api-client.
For more information about the api interfaces and the methods please refer to the Steam Web API documentation.
License
This software is licensed under the Mozilla Public License v. 2.0. For more information, read the file LICENSE.
