Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

Latest commit

 

History

History
45 lines (27 loc) · 1.88 KB

README.md

File metadata and controls

45 lines (27 loc) · 1.88 KB

VMPro PHP API Client

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)->getName() . PHP_EOL;

If you use Guzzle 5, make sure to use MovingImage\Client\VMPro\ApiClientFactory\Guzzle5ApiClientFactory instead of ApiClientFactory.

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.