installing an api

onlinestudio Peon

Messages:: 237

Likes Received:: 2

Best Answers:: 0

Trophy Points:: 0

#1

I am trying to install the revver api on one of my sites... but can't figure out the first thing about installing an api through php. Any resources or hints you can point out would be awesome. Thanks guys.

onlinestudio, Feb 17, 2008 IP

00johnny Peon

Messages:: 149

Likes Received:: 0

Best Answers:: 0

Trophy Points:: 0

#2

if your not familiar with apis at all might be worth starting with a simple one. Goto domaintools.com and get a developer account, you can use their apis to check domain registration... they have a full source code example you can use that uses and api calls... this may not be an exact answer your looking for but its a start....

00johnny, Feb 18, 2008 IP

jayshah Peon

Messages:: 1,126

Likes Received:: 68

Best Answers:: 1

Trophy Points:: 0

#3

Most API's come with some kind of documentation and example code bases. It's next to impossible to work without both of these, so dig around to see if you can find yours. The examples will show you what to send, what'll be received, and what to parse.

Jay

jayshah, Feb 18, 2008 IP

onlinestudio Peon

Messages:: 237

Likes Received:: 2

Best Answers:: 0

Trophy Points:: 0

#4

Yea the documentation is quite lacking in my opinion but here is what they give. They give this as sample code and then a folder with all of the different php files. So would I just ftp all of the given php files into a new folder on my server and then call up this script somehow.

<?php
/*
The RevverAPI class determines which method of packaging xmlrpc requests is to be
used, prepares and launches the method call and then returns the result as a standard
PHP variable. It requires curl support and will use the 'XMLRPC for PHP' library if
the built in XMLRPC functions for PHP are unavailable.

PHP
http://www.php.net/

XMLRPC
http://www.xmlrpc.com/

XMLRPC for PHP
http://www.php.net/xmlrpc
http://phpxmlrpc.sourceforge.net/
*/

class RevverAPI {
function RevverAPI($url) {
$this->url = $url;
$this->curl = function_exists('curl_init');
$this->xmlrpc = function_exists('xmlrpc_encode_request');
}

function callRemote($method) {
// Curl is required so generate a fault if curl functions cannot be found.
if (!$this->curl) return array('faultCode' => -1, 'faultString' => 'Curl functions are unavailable.');
// The first argument will always be the method name while all remaining arguments need
// to be passed along with the call.
$args = func_get_args();
array_shift($args);
if ($this->xmlrpc) {
// If php has xmlrpc support use the built in functions.
$request = xmlrpc_encode_request($method, $args);
$result = $this->__xmlrpc_call($request);
$decodedResult = xmlrpc_decode($result);
} else {
// If no xmlrpc support is found, use the phpxmlrpc library. This involves containing
// all variables inside the xmlrpcval class.
$encapArgs = array();
foreach ($args as $arg) $encapArgs[] = $this->__phpxmlrpc_encapsulate($arg);
$msg = new xmlrpcmsg($method, $encapArgs);
$client = new xmlrpc_client($this->url);
$client->verifypeer = false;
$result = $client->send($msg);
if ($result->errno) {
$decodedResult = array('faultCode' => $result->errno, 'faultString' => $result->errstr);
} else {
$decodedResult = php_xmlrpc_decode($result->value());
}
}
return $decodedResult;
}

function __phpxmlrpc_encapsulate($arg) {
// The class xmlrpcval is defined in the phpxmlrpc library. It requires both the variable
// and the type. Dates are handled through the API as ISO 8601 string representations.
if (is_string($arg)) {
$encapArg = new xmlrpcval($arg, 'string');
} elseif (is_int($arg)) {
$encapArg = new xmlrpcval($arg, 'int');
} elseif (is_bool($arg)) {
$encapArg = new xmlrpcval($arg, 'boolean');
} elseif (is_array($arg)) {
// The API server treats indexed arrays (lists) and associative arrays (dictionaries)
// differently where in php they are essentially the same. Assuming that having a zero
// index set indicates an indexed array is not perfect but should suffice for the
// purpose of the API examples.
if (isset($arg[0])) {
$array = array();
foreach ($arg as $key => $value) {
$array[] = $this->__phpxmlrpc_encapsulate($value);
}
$encapArray = new xmlrpcval();
$encapArray->addArray($array);
$encapArg = $encapArray;
} else {
$struct = array();
foreach ($arg as $key => $value) {
$struct[$key] = $this->__phpxmlrpc_encapsulate($value);
}
$encapStruct = new xmlrpcval();
$encapStruct->addStruct($struct);
$encapArg = $encapStruct;
}
} else {
$encapArg = new xmlrpcval($arg, 'string');
}

return $encapArg;
}

function __xmlrpc_call($request) {
$header[] = "Content-type: text/xml";
$header[] = "Content-length: ".strlen($request);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $this->url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_TIMEOUT, 30);
curl_setopt($ch, CURLOPT_HTTPHEADER, $header);
curl_setopt($ch, CURLOPT_POSTFIELDS, $request);

curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);

$data = curl_exec($ch);
if (curl_errno($ch)) {
// Curl errors are returned as emulated xmlrpc faults.
$errorCurl = curl_error($ch);
curl_close($ch);
return xmlrpc_encode(array('faultCode' => -1, 'faultString' => 'Curl Error : '.$errorCurl));
} else {
curl_close($ch);
return $data;
}
}

}

/*
user.create
Attempt to create a new user with a login name of longjohn and the provided details.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$login = 'longjohn';
$options = array(
'password' => 'avast888',
'email' => 'longjohn@example.net',
'paypal' => 'longjohn@example.com',
'allowBroadcast' => true,
'allowMobile' => false
);

$results = $api->callRemote('user.create', $login, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
user.find
Return the login, email address, paypal address and balance details of the first 10
active users.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$query = array('statuses' => array('active'));
$return = array('login', 'email', 'paypal', 'balance');
$options = array('limit' => 10, 'offset' => 0);

$results = $api->callRemote('user.find', $query, $return, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
user.count
Determine how many active users exist.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$query = array('statuses' => array('active'));

$results = $api->callRemote('user.count', $query);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
user.authenticate
Determine if the user blackbeard with a password of avast888 is valid.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$username = 'blackbeard';
$password = 'avast888';

$results = $api->callRemote('user.authenticate', $username, $password);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
user.update
Update the email address of the user longjohn to .
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$login = 'longjohn';
$options = array('email' => 'longjohn@arrmail.com');

$results = $api->callRemote('user.update', $login, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
user.delete
Delete the users longjohn and davyjones.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$logins = array('longjohn', 'davyjones');

$results = $api->callRemote('user.delete', $logins);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
collection.create
Create a video collection called 'Parrots of the World' that is owned by blackbeard.
Include in this collection all videos tagged with the keyword parrot.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$type = 'video';
$name = 'Parrots of the World';
$query = array('keywords' => array('parrot'));
$options = array('owner' => 'blackbeard');

$results = $api->callRemote('collection.create', $type, $name, $query, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

collection.update
Change the name of collection 5777 to 'Monkeys of the World' and change the
collection query to videos tagged with the keywords monkey or chimp.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$id = 5777;
$collection = array(
'name' => 'Monkeys of the World',
'query' => array('keywords' => array('monkey', 'chimp'))
);

$results = $api->callRemote('collection.update', $id, $collection);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
collection.delete
Delete collections 5777, 5787 and 5798.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$ids = array(5777, 5787, 5798);

$results = $api->callRemote('collection.delete', $ids);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
collection.find
Return the id, owner, name and type of the first 10 video collections.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$query = array('types' => array('video'));
$return = array('id', 'owner', 'name', 'type');
$options = array('limit' => 10);

$results = $api->callRemote('collection.find', $query, $return, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
collection.collect
Return the id, title and thumbnail image url of all videos in collection 5366.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$id = 5366;
$return = array('id', 'title', 'thumbnailUrl');

$results = $api->callRemote('collection.collect', $id, $return);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
video.find
Return the id, title and thumbnail url of the 10 most viewed videos owned by
longjohn that contain the word parrot in their metadata.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$query = array('owners' => array('longjohn'), 'search' => array('parrot'));
$return = array('id', 'title', 'thumbnailUrl');
$options = array('limit' => 10, 'orderBy' => array('views', true));

$results = $api->callRemote('video.find', $query, $return, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

video.getUploadTokens
Return 1 upload token for a new video to be owned by blackbeard.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$count = 1;
$options = array('owner' => 'blackbeard');

$results = $api->callRemote('video.getUploadTokens', $count, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

video.create
Create the metadata for video 65535.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$id = 65535;
$title = 'My New Parrot';
$keywords = array('parrot', 'pet');
$ageRestriction = 1;
$options = array('url' => 'arrvideos.example.com', 'author' => 'Billy Doyle');

$results = $api->callRemote('video.create', $id, $title, $keywords,
$ageRestriction, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

video.count
Determine how many videos owned by longjohn contain the word parrot in the metadata.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$query = array('owners' => array('longjohn'), 'search' => array('parrot'));

$results = $api->callRemote('video.count', $query);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
video.rate
Set the rating of video 65535 to 4.5 for the identified client.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$id = 65535;
$client = '192.0.0.1';
$rating = 4.5;

$results = $api->callRemote('video.rate', $id, $client, $rating);

echo '<pre>';
var_dump($results);
echo '</pre>';

/*
video.update
Update the metadata for video 65535 to include parrot, pet and galah as the keywords.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$id = 65535;
$options = array('keywords' => array('parrot', 'pet', 'galah'));

$results = $api->callRemote('video.update', $id, $options);

echo '<pre>';
var_dump($results);
echo '</pre>';

video.delete
Delete videos 65535, 65808 and 66002.
*/

include('xmlrpc-2_1/lib/xmlrpc.inc');
include('class.RevverAPI.php');

$api = new RevverAPI('https://api.staging.revver.com/xml/1.0?login=revtester&passwd=testacct');

$ids = array(65535, 65808, 66002);

$results = $api->callRemote('video.delete', $ids);

echo '<pre>';
var_dump($results);
echo '</pre>';
?>
Click to expand...

onlinestudio, Feb 18, 2008 IP

Log in or Sign up

installing an api

onlinestudio Peon

00johnny Peon

jayshah Peon

onlinestudio Peon

Useful Searches