movingimage/vmpro-api-client

API client library for the VMPro public API


README

Build Status Code Coverage License Latest Unstable Version Latest Stable Version

Installation

To install the API client, run the following command:

composer require movingimage/vmpro-api-client

Usage

To use the VMPro API Client, you can use the factory like this:

<?php

use MovingImage\Client\VMPro\Entity\ApiCredentials;
use MovingImage\Client\VMPro\ApiClientFactory;

require_once('./vendor/autoload.php');

$baseUri     = 'https://<api uri>';
$credentials = new ApiCredentials('<username>', '<password>');
$factory     = new ApiClientFactory();

$apiClient = $factory->createSimple($baseUri, $credentials);

echo $apiClient->getChannels(5, 'en')->getName() . PHP_EOL;

Maintainers

If you have questions, suggestions or problems, feel free to get in touch with the maintainers by e-mail.

Contributing

If you want to expand the functionality of the API clients, or fix a bug, feel free to fork and do a pull request back onto the 'master' branch. Make sure the tests pass by running ./vendor/bin/phpunit.