de | en

Template API

iStylr Template API

Attention developers! We offer you the possibility to create a white-label version of our template marketplace. You can display all public templates available in our marketplace in your own website or application.

As we currently offer a pull api only we descided to use the common RSS2.0 specification combined with OpenSearch to make it easy for you to access our api.

On this page you can learn how to use the api and get to know all parameters available.

Table of Contents

API Basics

Fetch Result Set as RSS2.0

We tried to make the use of our api as comfortable as possible. That's why we offer a link directly to the result set of templates you are viewing in the template marketplace. You can click on the RSS icon to view the generated feed or you can copy the link to use it in your programming code.

The RSS link will adapt to the search query you have used and it will reflect any parameters that you used to get to the results you are viewing in the marketplace.

If you are performing a search by tag for example all RSS links will automatically contain the tag you used as well as the page you are currently viewing. If you limited your results to a certain cms, this limit will be included in the RSS link as well.

API Parameters

The basic url to the api is very simple. Instead of using the regular link to the marketplace you just have to add &format=rss to the url in order to acces the template feed.

API Parameter Details and Description

se_mode : This parameter is used to define the search mode. Possible values are:

  • name: search templates by name and/or description (default)
  • tag: search templates by tag
  • author: search templates by author

dq : This parameter is mandatory if you defined se_mode and it represents the search query. Possible values are:

  • any string: search templates for this value

se_system : This parameter is used to filter results by cms. Possible values currently are:

  • all: display templates of any cms available (default)
  • aos: display AutomaticOnlineShop templates only
  • drupal: display Drupal themes only
  • istylr: display regular xhtml/iStylr templates only
  • joomla: display Joomla templates only
  • nexecutive: display nexecutive templates only
  • typolight: display TYPOlight templates only
  • wordpress: display WordPress themes only

se_sort : This parameter is used to sort the results in any available order. Possible values are:

  • newdesc: sort results by id descending (from high to low)
  • newasc: sort results by id ascending (from low to high)
  • newudesc: sort results by last update descending (from lates update to last) (default)
  • newuasc: sort results by last update ascending (from last update to latest)
  • votedesc: sort results by user-rating descending (highest rating first)
  • viewdesc: sort results by views descending (most views first)

howMany : This parameter is used to define how many results will be delivered. Possible values are:

  • Any positive integer value between 1 and 100 (default value is 15)

startRow : This parameter defines the first result delivered similar to a page parameter. If you set howMany to 15 and you want to recieve the second result set you would use startRow=15 and startRow=30 for the third result set respectrively. Possible values are:

  • Any positive integer greater or equal to 0 (default value is 0)

API URL Examples

Example 1 - show the latest 100 wordpress themes:

  • http://istylr.com/?i=itemplates&format=rss&se_system=wordpress&howMany=100


Example 2 - show the latest 50 templates of any cms tagged with blue:

  • http://istylr.com/?i=itemplates&format=rss&se_system=all&howMany=50&se_mode=tag&dq=blue


Example 3 - show page 2 (15 results each) of the best voted nexecutive templates:

  • http://istylr.com/?i=itemplates&format=rss&se_system=nexecutive&howMany=15&startRow=15&se_sort=votedesc


Example 4 - show 100 templates designed by nexenator (an iStylr username):

  • http://istylr.com/?i=itemplates&format=rss&howMany=100&se_mode=author&dq=nexenator

OpenSearch

As stated above all API RSS feeds are enriched with the OpenSearch specification. This enables you to programaticaly recieve the total results, the current page/result-set and the results per page of any given API query. This way you can easily create a pagination and you will always know how many results are available on any given query.

OpenSearch Feed Example

For more details about the OpenSearch specification please click here.

API Image Enclosures

Every item returned in the API result feed contains 3 image thumbnails of the template. These enclosures are sorted descending by size. So the first enclusure represents the biggest thumbnail with a dimension of 640 by 480 pixel and always ends with l.jpg (as in large). The second enclosure, the medium sized thumbnail has the dimensions 202 by 151 pixel and ends with s.jpg. And the third enclosure comes in the dimensions 92 by 69 pixel and it ends with xs.jpg.

RSS Item Details

Questions, Comments and Feedback

If you need additional support or if you've got a question concering our API that is not answered above, please feel free to to get in touch with us!





Captcha