Kuler
From Adobe Labs
| Table of contents |
kuler APIs
kuler is all about color and inspiration: explore, create, and share color themes.
Due to popular demand we are publishing the kuler APIs (Application Programming Interfaces). These APIs allow you to submit requests to http://kuler.adobe.com/kuler/API/, which returns lists of feeds (highest rated, most popular, and newest color themes posted to the site) or searches themes.
Prior to using these APIs, please review the API documentation below and the kuler Terms of Use, and download the kuler API logo. This logo must be included on your website/application. If you name your mashup, have fun, but be aware that you cannot use "kuler" as part of the name. For details, see the Adobe trademark guidelines and Adobe guidelines for third parties. By using the APIs, you indicate that you have read and agreed to the kuler Terms of Use.
Questions? For general questions, review the kuler API FAQ. To discuss the APIs, use the discussion tab at the top of this page, or the kuler talk forum. If you are still unable to find an answer, please click on This reCaptcha Link for an address you can send an email.
We're excited to see what you come up with. Let us know on the kuler mashup page and feel free to post on the kuler talk forum. We eventually plan to feature the best applications on the Adobe Developer Center. Have fun!
RSS Feeds
The following API requests return lists of formatted RSS feed items. The syntax in each case follows the prefix http://kuler.adobe.com/kuler/API/
Get RSS Feeds
| rss/get.cfm?listtype=[listtype]&startIndex=[startIndex]&itemsPerPage=[itemsPerPage] |
Returns a list of feeds of a specified type.
- listType: Optional. One of the strings recent (the default), popular, rating, or random.
- startIndex: Optional. A 0-based index into the list that specifies the first item to display. Default is 0, which displays the first item in the list.
- itemsPerPage: Optional. The maximum number of items to display on a page, in the range [1..100]. Default is 20.
- timeSpan: Optional. Value in days to limit the set of themes retrieved. Default is 0, which retrieves all themes without time limit.
Example usage
- Get highest-rated feeds
http://kuler.adobe.com/kuler/API/rss/get.cfm?listtype=rating
- Get most popular feeds for the last 30 days
http://kuler.adobe.com/kuler/API/rss/get.cfm?listtype=popular×pan=30
- Get most recent feeds
http://kuler.adobe.com/kuler/API/rss/get.cfm?listtype=recent
- Get random feeds
http://kuler.adobe.com/kuler/API/rss/get.cfm?listtype=random
Search RSS Feeds
| rss/search.cfm?searchQuery=[searchQuery]&startIndex=[startIndex]&itemsPerPage=[itemsPerPage] |
Returns a list of feeds that meet specified search criteria.
- searchQuery: Optional. A search filter. This can be one of the predefined filters listed below, or a simple string term to search on; for example, "blue". If you specify a simple term, the search looks for that term in theme titles, tags, author names, themeIDs, authorIDs, and hexValues. By default, retrieves all available feeds.
These filters are available:- themeID:[themeID] - search on a specific themeID
- userID:[userID] - search on a specific userID
- email:[email] - search on a specific email
- tag:[tag] - search on a tag word
- hex:[hex] - search on a hex color value (can be in the format "ABCDEF" or "0xABCDEF")
- title:[title] - search on a theme title
- startIndex: Optional. A 0-based index into the list that specifies the first item to display. Default is 0, which displays the first item in the list.
- itemsPerPage: Optional. The maximum number of items to display on a page, in the range [1..100]. Default is 20.
Example usage
- Search for themes with the word "blue" in the name, tags, user name, etc.
http://kuler.adobe.com/kuler/API/rss/search.cfm?searchQuery=blue
- Get feeds for a specific e-mail user
http://kuler.adobe.com/kuler/API/rss/search.cfm?searchQuery=email:user@kuler.com
- Search for themes tagged as "sunset"
http://kuler.adobe.com/kuler/API/rss/search.cfm?searchQuery=tag:sunset
Themes
Theme Thumbnail
| rss/png/generateThemePng.cfm?themeid=[theme_id] |
Retrieves a thumbnail of a specific theme
- themeid: Required. The id of a specified theme.
For example:
http://kuler.adobe.com/kuler/API/rss/png/generateThemePng.cfm?themeid=11
View Theme
To view a specific theme directly in the kuler public website, use the following URL:
| http://kuler.adobe.com/#themeID/[theme_id] |
For example:
http://kuler.adobe.com/#themeID/42374
View Comments
Returns a list of comments for either a specified theme (if a themeID is provided) or for all of a member's themes (if an email is provided)
| rss/comments.cfm?themeID=[themeID]&email=[email]&startIndex=[startIndex]&itemsPerPage=[itemsPerPage] |
- themeID: Optional. When this value is used, all comments are retrieved for the specified theme
- email: Optional. When this value is used, comments are retrieved for themes created by this user
- startIndex: Optional. A 0-based index into the list that specifies the first item to display. Default is 0, which displays the first item in the list.
- itemsPerPage: Optional. The maximum number of items to display on a page, in the range [1..100]. Default is 20.
Example usage
- Get comments for theme (firenze)
http://kuler.adobe.com/kuler/API/rss/comments.cfm?themeID=24198&itemsPerPage=20&startIndex=0
- Get comments for a member
http://kuler.adobe.com/kuler/API/rss/comments.cfm?email=user@kuler.com&itemsPerPage=20&startIndex=0
