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 Extend 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 =====

**Extend ID based call:**
<code>http://get-simple.info/api/extend/?id=##</code>
Replace ''##'' with the ID of your plugin in our Extend repository. You can get your id by logging into Extend and viewing the particular file in question. This is the most 100% sure-fire way to identify your plugin because just as long as you do not delete your plugin from Extend, your ID will //never// change. [[http://get-simple.info/api/extend/?id=30|Live example]]

**Plugin Initial File based call:** (plugins only)
<code>http://get-simple.info/api/extend/?file=#####.php</code>
Replace ''#####.php'' with the filename of your main plugin file. In order to use this call, your plugin needs to be [[plugins:update_notifications|packaged the correct way]] before uploaded into Extend. This will only work if your main-file is completely unique across all plugins within Extend. Try to name your main plugin file something completely unique. (This is the way that GS v3.1 checks to see if plugin updates are available.) [[http://get-simple.info/api/extend/?file=translate.php|Live example]]

===== API Result Set =====
The result set for either call above sends back a json encoded string that looks like this:

<code json>
{"status":"successful","id":"112","filename_id":"translate.php","name":"Translate","version":"0.3","category":"Plugin","tags":"translation, languages, internationalization, i18n","tested_with":"2.03","updated_date":"March 25, 2011","support_url":"http:\/\/get-simple.info\/forum\/topic\/1610\/translation-plugin\/","author_url":"http:\/\/mvlcek.bplaced.net","owner":"mvlcek","path":"http:\/\/get-simple.info\/extend\/plugin\/translate\/112\/","file":"http:\/\/get-simple.info\/extend\/export\/2902\/112\/translate.zip","downloads":"80","rating":""}
</code>

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

<code php>
stdClass Object
( 
  [author_url] => http=>//mvlcek.bplaced.net
  [category] => Plugin
  [downloads] => 80
  [file] => http=>//get-simple.info/extend/export/2902/112/translate.zip
  [filename_id] => translate.php
  [id] => 112
  [name] => Translate
  [owner] => mvlcek
  [path] => http=>//get-simple.info/extend/plugin/translate/112/
  [rating] => 4.8
  [status] => successful
  [support_url] => http=>//get-simple.info/forum/topic/1610/translation-plugin/
  [tags] => translation, languages, internationalization, i18n
  [tested_with] => 2.03
  [updated_date] => March 25, 2011
  [version] => 0.3
)</code>

===== PHP Example Code =====

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>

===== Extend API Limitations =====

This API is cached, and is allowed to be 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 this API responsibly.
GetSimple CMS Wiki

User Tools

Site Tools

Page Tools
