mlsapi/mlsapi-php-sdk

v1.0.0 2022-08-06 01:58 UTC

This package is auto-updated.

Last update: 2022-09-10 13:56:20 UTC


README

Build Status Latest Stable Version Total Downloads License

The library provides convenient access to the MLS API functionality from applications written in the PHP language.

Requirements

PHP 7.x.x and later.

Dependencies

The library require the following extensions in order to work properly:

If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.

Development

Get Composer. For example, on macOS:

brew install composer

Install dependencies:

composer install

Manual Testing

Set environment variables in terminal. For example, on macOS:

export username="public_prototype"
export password="public_prototype"

# The login credentials are for the prototype plan. Rate limiting applies.

Execute test:

composer update && composer validate
./vendor/bin/phpunit tests

Getting Started

Install

You can install the library via Composer. Run the following command:

composer require mlsapi/mlsapi-php-sdk

Usage

Simple usage requires you to init and authenticate.

use Mlsapi\Mlsapi\Client;

$sdk = Client::init($config); // guzzle config .
$sdk->authentication($username, $password); // return auth data.

Alternatively, you can save the token.

$sdk = Client::initWithToken($token);

Then, you can call the MLS API endpoint to retrieve data.

$sdk->teams()->getAll();
$sdk->teams()->getById($id);

// Additional API Endpoints
//
// teams
// players
// hist
// rtd
// assists
// offence
// topscorer
// fixtures
// standings
// news

The MLS API documentation is available here. If you need further assistance, don't hesitate to contact us.

License

This project is licensed under the MIT License.

Copyright

(c) 2022 Moat Systems Limited.