GetSimple CMS Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Using the GetSimple API ======

With the creation of GetSimple Extend comes a new API that allows developers the ability to grab vital statistics from your Extend profile and integrate them into your site or plugin. For example, A plugin developer can now code their plugin to look at our API and automatically determine if there is an update available or not.

===== API Syntax =====

''http://get-simple.info/api/extend/?id=##''

Replace ## with the ID of your plugin in our repository. You can get your id by logging into Extend and viewing your files.

[[http://get-simple.info/api/extend/?id=30|Live example]]

The API sends back a json encoded string that looks like this:

<code json>
{"status":"successful","id":"30","name":"Cardinal","version":"1.0","downloads":"4", "category":"Theme","path":"http:\/\/get-simple.info\/extend\/theme\/cardinal\/30\/", "file":"http:\/\/get-simple.info\/extend\/download.php?file=files\/2\/cardinal.zip&id=30", "owner":"ccagle8","tags":"cardinal, red, two column"}
</code>

Since this is json, you can turn the above into a PHP array with json_decode($response). The resulting array will look like this:

<code php>
stdClass Object
(
    [status] => successful
    [id] => 30
    [name] => Cardinal
    [version] => 1.0
    [downloads] => 2
    [category] => Theme
    [path] => http://get-simple.info/extend/theme/cardinal/30/
    [file] => http://get-simple.info/extend/download.php?file=files/2/cardinal.zip&id=30
    [owner] => ccagle8,
    [tags] => cardinal, red, two column
)</code>

===== Full Example in PHP =====

This will echo out the latest version number for the live example above.

<code php>
$my_plugin_id = 30; // replace this with yours

$apiback = file_get_contents('http://get-simple.info/api/extend/?id='.$my_plugin_id);
$response = json_decode($apiback);
if ($response->status == 'successful') {
	// Successful api response sent back. 
	$current_ver = $response->version;
}

echo $current_ver;
</code>

===== Limitations =====

This API is only refreshed every 4 hours. This is to limit the server load for a service that does not need to be checked any more frequently than that. Please use responsibly.
GetSimple CMS Wiki

User Tools

Site Tools

Page Tools
