Accessing Miso API: a sample PHP application

Miso recently introduced the ability to access their data through API which is really great, I’m already using it in production on Italiansubs.net.

The documentation (that you should definitely read) is well written and  easy to follow if you have any experience in working with json API and OAuth, but if you haven’t, and you don’t know Ruby (the programming language used for their sample application) it’s possible to find it tricky.

So, here’s the sample PHP application:

First, install the PECL OAuth library

pecl install oauth

And add the extension to your php.ini file

extension=oauth.so

The first file is the configuration file (misoconfig.php)

define('OAUTH_CONSUMER_KEY',"yourconsumerkey");
define('OAUTH_CONSUMER_SECRET',"yourconsumersecret");
define('OAUTH_REQUEST_TOKEN_API', 'https://gomiso.com/oauth/request_token');
define('OAUTH_ACCESS_TOKEN_API', 'https://gomiso.com/oauth/access_token');
define('OAUTH_AUTHORIZE_API', 'https://gomiso.com/oauth/authorize');
define('OAUTH_TMP_DIR', function_exists('sys_get_temp_dir') ? sys_get_temp_dir() : realpath($_ENV["TMP"]));
define('MISO_USER_AGENT', 'youruseragent');

The next file requests a token, saves it in a tmp file and redirects the user to Miso for the authentication, if the user allows your application, he will be redirected to the callback url

require 'misoconfig.php';
$req_url = OAUTH_REQUEST_TOKEN_API;
try {
$o = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET,
OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_FORM);
$o->enableDebug();
$resp = $o->getRequestToken($req_url, "http://www.yourwebsite.com/callback.php");
} catch(OAuthException $E) {
echo "Response: ". $E->lastResponse . "\n";
}
file_put_contents("/tmp/last_request",$resp['oauth_token']."\n".
$resp['oauth_token_secret']."\n");
print_r ($resp);
header("Location: ".OAUTH_AUTHORIZE_API."?oauth_token=".$resp['oauth_token']);

The last file (callback.php) lets us acquire the access token by using the previous request token and the oauth verifier:

require 'misoconfig.php';
$acc_url = OAUTH_ACCESS_TOKEN_API;
list($token,$secret) = file('/tmp/last_request');
$token = trim($token);
$secret = trim($secret);
$verifier = $_GET['oauth_verifier'];
try {
$o = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET,
OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_URI);
$o->enableDebug();
$o->setToken($token,$secret);
$resp = $o->getAccessToken($acc_url, NULL, $verifier);
file_put_contents("/tmp/access_token.txt",serialize($resp));
} catch(OAuthException $E) {
echo "Response: ". $E->lastResponse . "\n";
}
print_r($resp);

We’re done! We can now access Miso’s API using the access token, you can test it with something like this:

try {
$oauth = new OAuth(OAUTH_CONSUMER_KEY,OAUTH_CONSUMER_SECRET,OAUTH_SIG_METHOD_HMACSHA1,OAUTH_AUTH_TYPE_AUTHORIZATION);
$oauth->setToken($oauth_token,$oauth_token_secret);
$oauth->fetch('http://gomiso.com/api/oauth/v1/users/show.json', null, OAUTH_HTTP_METHOD_GET, array('User-Agent'=>''.MISO_USER_AGENT.''));
$response_info = $oauth->getLastResponseInfo();
header("Content-Type: {$response_info["content_type"]}");
echo $oauth->getLastResponse();
} catch(OAuthException $E) {
echo "Exception caught!\n";
echo "Response: ". $E->lastResponse . "\n";
}

Please note that this is just an example that should let you understand how to access Miso API, it won’t work out of the box just by uploading this code snippets into your FTP.