Rovi Cloud Services Client Library for PHP
###PHP client libraries created with Mashery I/O Wraps, a semi-automated native language SDK generator.
What is the Rovi Cloud Services API?
Rovi is a global leader in digital entertainment technology for some of the largest CE manufacturers, service providers and online, mobile and application developers in the world. We now have a range of APIs that can help you to create and deliver an even more enhanced entertainment experience to your customers.
Head over to developer.rovicorp.com to learn more. You can register for instant access to their API, view their documentation, and even make live API calls with their interactive docs.
An API client library (also known as an SDK or language wrapper) is an efficiency tool for programmer that helps bind external resources to your native programming language. Traditionally, to integrate an API into your project without a client library, you would need to do the following:
Construct a network request using a transport library (e.g. HTTP)
Integrate authentication flow and signatures (e.g. OAuth, MD5/SHA-256, etc.)
Construct and execute API calls manually, often a trial and error process while reading documentation
Parse through results
Lather. Rinse. Repeat.
How does the client library help?
Client libraries make life easier by bringing the API into your native language environment. So, rather than making curl calls, piping the output into a variable, and parsing through the variable -- the client library handles the network connectivity, authorization and API call execution with syntax you're familiar with:
// Initialize the client library $client = new apiClient(); // Set your API key $client->setDeveloperKey("YOUR_KEY_HERE"); $client->setDeveloperSecret("YOUR_SECRET_HERE"); // Connect client to the API $api = new apiService($client); // Make an API call and store the response in a variable/object $responseObj = $api -> AutocompleteMethods -> Autocomplete ("lady");
Above is just a pseudo-PHP-code example of how this library works. If you'd like to see it in action, check out the example PHP files in this repo.
- PHP - if you'd like a quick a dirty isolated LAMP stack, check out XAMPP. Works on Mac, PC and even Linux.
- Rovi Cloud Services API key -- head over to http://developer.rovicorp.com
IDE is optional, but nice
At Mashery, we love vim just as much as the next guy, but when it comes to tool-tips, code-completion and general object-oriented goodness, IDEs can be really useful. Eclipse, Aptana, Netbeans, Komodo, etc. They're all very mature and useful tools.
Installation / Quick Start Guide
Follow the steps below for a quick start to using this client library:
Grab the latest source with git.
git clone git://github.com/mashery/io-wraps-rovi-php.git
Move the project source tree into your sandbox LAMP stack environment (anywhere below the httpdocs/htdocs level -- example code is relatively linked)
Head over to Rovi Cloud Services to fetch an API key
Open up your editor and add your API key where you see YOUR_KEY_HERE on the sample PHP scripts.
Point your browser to one of the example files where this is deployed: