API abbr. Application Programming Interface - Generic term for any language and format used by one program to help it communicate with another program.

The API's consist of a set of callable methods, and API endpoints. To perform an action using my API, you need send a request to the endpoint specifying a method and some arguments, and will receive an XML formatted response.


Why use this API?

To be honest, this is a project born out of my own need and curiosity, the need to use the data on this site for other projects and the curiosity to learn the fundementals of creating an API. You are however free to use the data / service if it is of use to you.


Getting Started

Here is a list of the API's availiable. Here's how to get started:

  1. Read the online documentation
  2. Apply for an API Key
  3. Code Away!

A full list of documentation will be availiable soon, at this moment in time the API is in development and is not availiable for third party use. API Keys will be available to people who register for an account and apply, all API key applications need to be reviewed before they are released.


API's

Events API Client API

Sample Code

To Make a call to the API you will need to have CURL installed on your server, currently PHP is the only supported language, and XML is the only form of structured response.

$vals = array('api_key' => '[API KEY HERE]', 'method' => 'getSample', 'limit' => '5');

foreach($vals as $key => $value) {
$ret .= $key.'='.urlencode($value).'&';
}

$ret = rtrim($ret, '&');

$ch = curl_init("http://www.mylesnoton.com/api/example/get.php");
curl_setopt($ch, CURLOPT_HEADER, 0);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $ret);
$response = curl_exec($ch);
curl_close ($ch);

Accepted Arguments

The REQUIRED parameter api_key is used to specify your API Key.

The REQUIRED parameter method is used to specify the calling method.

The Optional parameter id is used to specify which event record you want.

The Optional parameter limit is used to specify how many records you want.

NOTE: The arguments, responses and error codes for each method will be availiable soon!



All API services are experimental and are currently offered with no guarantee of uptime or availability of continued service. I reserve the right to disable access to any or all external applications at any time. I am not responsible for the content or features provided by outside application developers, or any problems caused by the use of the API.

© Myles Noton 2009. All Rights Reserved. Some images hosted by Flickr. Site Administration.