API, Aviation, Blog, PHP

Aviation Quotes API

As part of our ongoing introduction to our suite of APIs, we'll be providing a very basic introduction to our aviation quotes database. At the time of writing our list of quotes sits at around 5000... however there's barely 700 that are 'activated' (meaning the others haven't been verified). As such, the source should be considered very much a work in progress.

The Result

Not unlike the standard quotes API, data may be queried by quote ID (for a single quote, id=123), or by search term (type=search&search=crash). Regardless of what query is made, the data array returned in each case includes identical fields. The endpoint in all cases is as follows:

https://api.beliefmedia.com/platform/sources/quotes/aviation.json

An API Key is required, and an optional pg and number parameter may be supplied for pagination purposes. If searching results, the search type must be provided (type=search). If no search type is provided, the browse type is assumed.

Returning a Single Quote

A single quote may be returned as follows: aviation.json?apikey=xxxxx&id=gY. The result:

Array

(

[code] => 200

[status] => 200

[message] => OK

[source] => BeliefMedia

[data_version] => 0.2

[data] => Array

(

[itemid] => rE

[quote] => You've never been lost until you've been lost at Mach 3.

[author] => Paul F. Crickmore

[nsfw] => 0

=> Array

(

[filename] => aviation/rE.jpg

[size] => 55.2K

[width] => 885

[height] => 885

)

With each result there's a a few images; just one is referenced in the returned JSON. The primary purpose of prefabricating an image is so we can send them to social without the overhead of manufacturing them in real time. Having an image also makes paginated 'visual' results easy to render. If we build you your own set of branded images the filename is honored.

Sample Image Returned via the API

Sample PHP Functions

The following are the most basic of functions necessary to retrieve data. An API Key is provided to all clients and is available to others upon request.

Returning Single Result

Returning a single result will often return multiple image formats. It may also contain data about the individual responsible for the quote.

<?php

Aviation Quotes API

https://www.beliefmedia.com.au/aviation-quotes-api

function beliefmedia_aviation_quote($id, $apikey = 'xxxxx') {

$data = @file_get_contents('https://api.beliefmedia.com/platform/sources/quotes/aviation.json?apikey=' . $apikey . '&id=' . $id);

if ($data === false) return false;

$data = json_decode($data, true);

if ($data === false) return false;

/* Likely return array of errors with code & message */

if ($data['code'] != '200') return $data['message'];

/* Do something with data */

return (array) $data;

}

Usage:

$results = beliefmedia_aviation_quote($id = 'Ev');

echo '

<pre>' . print_r($results, true) . '</pre>

Browsing or Searching Results

<?php

Aviation Quotes API

https://www.beliefmedia.com.au/aviation-quotes-api

function beliefmedia_aviation_quotes($page = '', $number = '', $type = false, $search = false, $apikey = 'xxxxx') {

if ($page == '') $page = '1';

if ($number == '') $number = '20';

if ($type === false) $type = 'browse';

/* Correct for invalid search type */

$permitted_types = array('browse', 'search');

if (!in_array($type, $permitted_types)) $type = 'browse';

$type = ($type == 'browse') ? 'browse' : 'type=' . $type . '&search=' . str_replace(' ', '+', $search);

$data = @file_get_contents('https://api.beliefmedia.com/platform/sources/quotes/aviation.json?apikey=' . $apikey . '&pg=' . $page . '&number=' . $number . '&' . $type);

if ($data === false) return false;

$data = json_decode($data, true);

if ($data === false) return false;

/* Likely return array of errors with code & message */

if ($data['code'] != '200') return $data['message'];

return (array) $data;

}

Usage:

$results = beliefmedia_aviation_quotes($page = '2', $number = '10', $type = false, $search = false, $apikey = 'xxxxx');

echo '

<pre>' . print_r($results, true) . '</pre>

Considerations

BeliefMedia are, without question, the most qualified digital agency in Australia that deals with the aviation industry. If you're after media, advertising, or marketing representation, give us a call.

We wrote a very mediocre "Aviation Quotes" WordPress plugin some time ago; that plugin will soon be retired and a more comprehensive product will take its place.
To exclude those results that may not be 'child friendly', use nsfw=0 in your request.

Featured Image: Chuck Yeager in front of the Bell X-1, which, as with all of the aircraft assigned to him, he named Glamorous Glennis (or some variation thereof), after his wife. Source: Wikipedia.

Download our 650-page guide on Finance Marketing. We'll show you exactly how we generate Billions in volume for our clients.