Download the PHP package sportrizer/sportysky-client-php without Composer
On this page you can find all versions of the php package sportrizer/sportysky-client-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package sportysky-client-php
SportySKY PHP client
How to integrate SportySKY within your PHP project
- Requirements
- Getting started
- API Client
- getCountryForecastResponse
- getRegionForecastResponse
- getDepartmentForecastResponse
- getSpotForecastResponse
- getSpotForecastByCodeAndCountryResponse
- getSpotsResponse
- getForecastResponse
- Integration with the SportySKY javascript library
- Caching
- SportySKY API responses
- JWT Authentication token
- Modifications
- Modification on API return
- Modification on API return and caching
- Examples
- Testing
Requirements
- PHP ^7.2
- Composer
Getting started
Install the SportySKY PHP client via the composer package manager :
API Client
getCountryForecastResponse
Example :
getRegionForecastResponse
Example :
getDepartmentForecastResponse
Example :
getSpotForecastResponse
Example :
getSpotForecastByCodeAndCountryResponse
Example :
getSpotsResponse
Example :
getForecastResponse
Example :
Integration with the SportySKY javascript library
This library is developed to work seamlessly with the SportySKY javascript library provided by SportRIZER.
Create a php script that will be called by the javascript library :
Note : The
SapiStreamEmitter
comes with a suggested library.
Install it with this command :
composer require laminas/laminas-httphandlerrunner
You should set your client ID ( SPORTYSKY_CLIENT_ID
) and client secret ( SPORTYSKY_CLIENT_SECRET
) in environment variables.
This script will authenticate your sever and return json from the SportySKY API that will be consumed by the javascript library.
Caching
SportySKY API responses
API calls are made by Guzzle which can be configured with the Kevinrob's cache middleware
You can for example provide a PSR-16 compatible Redis cache to the second argument of ApiClient
:
Note : The
predis/predis
package is required to make the Redis cache work.
Install it with this command :
composer require predis/predis
See full example
By default, the responses will be cached according to the cache headers provided by the API but you can define your own strategy : See more examples
Some other PSR-16 adapters are already shipped with this library :
https://github.com/desarrolla2/Cache#adapters
JWT Authentication token
By default, the JWT token is cached in the temporary system directory until its expiration but you can provide your own PSR-16 cache integration as the third argument of the Authenticator
.
Exemple with Redis :
Modifications
Modification on API return
API returns can be modified before processed or caching
Modification on API return and caching
Example with a cache File on /tmp
Examples
Integration with the JS library
Testing
All versions of sportysky-client-php with dependencies
psr/simple-cache Version ^1.0
desarrolla2/cache Version ^3.0
guzzlehttp/guzzle Version ^6.5
kevinrob/guzzle-cache-middleware Version ^3.3