Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Marketplace/REST

Eclipse Marketplace REST API Documentation

General Usage

This API is identified by 'api/p' at the end of most URLs.

One of the goals of the API that is to make it very simple for someone to figure out how to use the API by using the website. If you add the /api/p to the websites url it should return the equivalent data in an XML response.

We only returns listings without a commercial license for the Recently Updated Listings, Top Favorited Listings & Most Popular Listings API calls. There is an exception to this rule, we will include a listing with a commercial license if it was submitted by an Eclipse member company or advertiser.

URL Variables

  • client: [string] The only valid value for the client variable is org.eclipse.epp.mpc.core. This variable is usually sent from MPC to alter the default list. It's available for the Most Popular Listings, Top Favorited Listings, Recently Updated Listings and Featured Listings. Only installable listings owned by an Eclipse member company will be returned.
  • client.version: [osgi version] The version of the client making the request
  • product: [string] The product id of the target Eclipse, e.g. org.eclipse.sdk.ide or epp.package.java
  • product.version: [osgi version] The version of the running product of the target Eclipse, identical to the version of the product's branding plugin
  • runtime.version: [osgi version] The version of the org.eclipse.core.runtime bundle of the target Eclipse
  • platform.version: [osgi version] (since Kepler/MPC 1.2) The version of the org.eclipse.platform bundle of the target Eclipse
  • java.version: [string] The version of the JRE running the target Eclipse, as returned by the JRE's System.getProperty("java.version")
  • os: [string] Operating system of the user. Supported values are linux, win32 and macosx.
  • ws: [string] Window system of the user. Supported values are gtk, win32 and cocoa.
  • nl: [string] Language code of the user's locale, e.g. en_US or de_DE.
  • page_num: [integer] used for pagination to access additional results in a listing, the index start at 1. To get the second page of results use page_num=2.
  • limit: [integer] The number of result returned for a listing (favorites, recent, search, etc.) integer between 0 and 20, default to 10.

Example: http://marketplace.eclipse.org/featured/api/p?client=org.eclipse.epp.mpc.core&client.version=1.5.0.20160524-1910&product=epp.package.java&product.version=1.5.1.20121004-1506&runtime.version=3.8.0.v20120521-2346&platform.version=4.2.1.v201209141800&java.version=1.7.0_55&eclipse.uuid=13b60190-f33a-449b-a89b-c90b83a0c5a6&os=win32&ws=win32&nl=de_DE

Compatibility Filtering & Multiple Versions per Solution

Beginning with Eclipse Mars, all listings will be subject to server-side filtering based on compatibility with the target Eclipse version. In addition, the Marketplace server supports the specification of multiple solution versions, consisting of a version number, compatibility information, an update site and installable units (features).

The Eclipse version is determined by a query parameter with key 'platform.version' that can be added to any query, e.g. http://marketplace.eclipse.org/featured/api/p?platform.version=4.4.2.v20150204-1700. Its value should correspond to the version of the org.eclipse.platform bundle of the target Eclipse. See #Determining the Eclipse release version for details.

If no version information is available, the unfiltered results are returned. Otherwise, incompatible solutions will not be included in any listing. Requests to specific nodes will still return the node information, but not include any installable units or an update site url. Node detail information of compatible solutions will include the installable units, update site and version information for the pertinent Eclipse version. If multiple solution version specifications match the target Eclipse version, the last one in the list with support for the newest Eclipse version will be used.

Compatibility Tests

A test suite for compatibitility filtering and multiple version support is available in the Marketplace Client project. See Marketplace/REST/Tests for information on the available tests and how to run them yourself.

Determining the Eclipse release version

The Eclipse release version used to filter entries based on their stated compatibility is determined based on the query parameters sent with the request, see #URL Variables. The release version is calculated as follows:

  1. If platform.version exists, use it as the release version - This is the case for all versions of MPC since Kepler/MPC 1.2.0.
  2. If product is one of org.eclipse.sdk.ide or org.eclipse.platform.ide, use product.version as the release version. For these two product ids, the product.version is known to match the Eclipse release version (in general, that's not the case). This covers Eclipse 3.8 releases. For Juno, there were two parallel releases, 3.8 and 4.2. Those releases cannot be distinguished by their runtime.version, and platform.version isn't sent by those releases. However, the only official Eclipse.org releases for 3.8 were the two products listed here. For other product ids, the product.version is arbitrary and cannot be used to infer the Eclipse release version.
  3. Use runtime.version - Older release versions correspond to the major/minor version of the runtime plugin. Since the move to 4.x, this is no longer te case (i.e. Juno still had a runtime.version of 3.8.x and Kepler had a runtime.version of 3.9.x)

With the calculated release version, the release can be determined from the following mapping:

  • 4.5.x.xxx (Mars)
  • 4.4.x.xxx (Luna)
  • 4.3.x.xxx (Kepler)
  • 4.2.x.xxx (Juno)
  • 3.8.x.xxx (Eclipse 3.8 - parallel release to Juno)
  • 3.7.x.xxx (Indigo)
  • 3.6.x.xxx (Helios)
  • ...

If the calculated release version cannot be matched to an Eclipse release, no filtering will be performed.

Here are some example queries for the different versions as their corresponding MPC version would generate: Mars, Luna, Kepler, Juno, Eclipse SDK 3.8, Indigo, Helios

Retrieving a listing of all catalogs

http://marketplace.eclipse.org/catalogs/api/p

This will return a listing of all catalogs that are browsable with the MPC. It also includes basic branding parameters, like title and icon and strategies resolving dependencies. If you want to override this url (e.g. in your RCP application) you have to set the following system-property: 

-Dorg.eclipse.epp.internal.mpc.core.service.DefaultCatalogService.url=http://mydomain.tld

This setting will request the url http://mydomain.tld/catalogs/api/p to obtain all available catalogs.


XML example 

 <marketplace>
   <catalogs>
     <catalog id="38413" title="Eclipse Marketplace" url="http://mydomain.tld" selfContained="0" icon="http://marketplace.eclipse.org/sites/default/files/default_1_0.png">
       <description>Eclipse Marketplace (MP) is a place to find and keep track of Eclipse-based solutions.</description>
       <dependenciesRepository></dependenciesRepository>
       <wizard title="">
         <icon>http://marketplace.eclipse.org/sites/default/files/default_1.png</icon>
         <searchtab enabled="1">Search</searchtab>
         <populartab enabled="1">Popular</populartab>
         <recenttab enabled="1">Recent</recenttab>
         <news shorttitle="January 01/27" timestamp="1422334800">https://www.eclipse.org/community/eclipse_newsletter/2015/january/</news>
     </wizard>
   </catalog>
 </marketplace>
  • marketplace
    • catalogs
      • catalog
        • (@attribute) id: [int] Unique identifier
        • (@attribute) title: [string] Name of catalog
        • (@attribute) url: [string] Url prefix of the marketplace catalog
        • (@attribute) selfContained: [bool] TRUE/FALSE
        • (@attribute) icon: [string] Absolute url
        • description: [string] Short description
        • dependenciesRepository: [string]
        • wizard
          • (@attribute) title: [string] Title of Wizard
          • icon: [string] Absolute url
          • searchtab: [string] Search tab title
            • (@attribute) enabled: [bool] TRUE/FALSE
          • populartab: [string] Popular tab title
            • (@attribute) enabled: [bool] TRUE/FALSE
          • recenttab: [string] Recent tab title
            • (@attribute) enabled: [bool] TRUE/FALSE
          • news: [string] News content URL.
            • (@attribute) enabled: [bool] TRUE/FALSE

Retrieving A listing of Markets and Categories

http://marketplace.eclipse.org/api/p

This will return a listing of Markets and Categories, it includes URLs for each category, as well number of listings in each category.


XML example 

 <marketplace>
   <market name="Tools" id="31" url="http://marketplace.eclipse.org/category/markets/tools">
     <category id="1964" count="158" url="http://marketplace.eclipse.org/taxonomy/term/1964%2C31" name="Application Development Frameworks" />
   </market>
   <market name="Long Term Support" id="3429" url="http://marketplace.eclipse.org/category/markets/long-term-support" />
 </marketplace>
  • marketplace
    • market
      • (@attribute) name: [string] Title
      • (@attribute) id: [int] Unique identifier
      • (@attribute) url: [string] Url
      • category (optional)
        • (@attribute) id: [int] Unique identifier
        • (@attribute) count: [int] Listing count
        • (@attribute) url: [string] Url
        • (@attribute) name: [string] Title

Retrieving a set of listings from a specific Market / Category

http://markerplace.eclipse.org/taxonomy/term/[category id],[market id]/api/p

This call returns a set of listings that correspond to the category / market specified.

Example: If you wanted to return the XML for all Build and Deploy Listings in the Tools Market you would use this call.

http://marketplace.eclipse.org/taxonomy/term/4,31/api/p

And paginate through the results using the page_num parameter until there are no more results returned:

http://marketplace.eclipse.org/taxonomy/term/4,31/api/p?page_num=2

http://marketplace.eclipse.org/taxonomy/term/4,31/api/p?page_num=3

These urls are easily obtained from using the http://marketplace.eclipse.org/api/p call.


XML example 

 <marketplace>
   <category id="4" marketid="31" name="Build and Deploy" url="http://marketplace.eclipse.org/taxonomy/term/4%2C31">
     <node id="69" name="MyEclipse Enterprise Workbench" url="http://marketplace.eclipse.org/content/myeclipse-enterprise-workbench">
       <favorited>34</favorited>
       <installstotal>5394</installstotal>
       <installsrecent>0</installsrecent>
     </node>
   </category>
 </marketplace>
  • marketplace
    • category
      • (@attribute) id: [int] Unique identifier
      • (@attribute) marketid: [int] Unique identifier
      • (@attribute) name: [string] Title
      • (@attribute) url: [string] Url
      • node
        • (@attribute) id: [int] Unique identifier
        • (@attribute) name: [string] Listing Title
        • (@attribute) url: [string] Listing Url
        • favorited: [int] Number of times a listing was favorited
        • installstotal: [int] Install count
        • installsrecent: [int] Install count for the last month

Returning a Specific Listing

There are two methods of returning a specific listing.

http://marketplace.eclipse.org/content/[title]/api/p

and

http://marketplace.eclipse.org/node/[node id]/api/p

Calls to either URL will return a listing of contents of a node.


XML example 

 <marketplace>
   <node id="29591" name="JRebel for Eclipse" url="http://mydomain.tld/content/example">
     <type>resource</type>
     <categories>
       <category id="4" name="Build and Deploy" url="http://mydomain.tld/category/categories/build-and-deploy" />
       <category id="24" name="IDE" url="http://mydomain.tld/category/categories/ide" />
       <category id="9" name="J2EE Development Platform" url="http://mydomain.tld/category/categories/j2ee-development-platform" />
       <category id="17" name="Tools" url="http://mydomain.tld/category/categories/tools" />
       <category id="20" name="Web" url="http://mydomain.tld/category/categories/web" />
     </categories>
     <tags>
       <tag id="134" name="J2EE" url="http://mydomain.tld/category/free-tagging/j2ee" />
       <tag id="327" name="eclipse" url="http://mydomain.tld/category/free-tagging/eclipse" />
       <tag id="422" name="java ee" url="http://mydomain.tld/category/free-tagging/java-ee" />
       <tag id="573" name="tools" url="http://mydomain.tld/category/free-tagging/tools" />
       <tag id="614" name="productivity" url="http://mydomain.tld/category/free-tagging/productivity" />
     </tags>
     <owner>Oliver White</owner>
     <favorited>66</favorited>
     <installstotal>0</installstotal>
     <installsrecent>140372</installsrecent>
     <shortdescription>SHORT DESCRIPTION</shortdescription>
     <body>LONG DESCRIPTION</body>
     <created>1295963961</created>
     <changed>1424896414</changed>
     <foundationmember>1</foundationmember>
     <homepageurl>http://www.zeroturnaround.com/software/jrebel/</homepageurl>
     <image>http://mydomain.tld/sites/all/themes/solstice/_themes/solstice_marketplace/public/images/default.png</image>
     <license>Commercial</license>
     <companyname>ZeroTurnaround</companyname>
     <status>Mature</status>
     <supporturl>http://www.zeroturnaround.com/jrebel/documentation/</supporturl>
     <version />
     <eclipseversion>4.5, 4.4, 4.3, 4.2, 4.1</eclipseversion>
     <updateurl>http://update.zeroturnaround.com/update-site</updateurl>
     <ius>
       <iu selected="TRUE">org.zeroturnaround.eclipse.feature</iu>
       <iu selected="TRUE">org.zeroturnaround.eclipse.wtp.feature</iu>
       <iu selected="TRUE">org.zeroturnaround.eclipse.m2e.feature</iu>
     </ius>
     <platforms>
       <platform>Windows</platform>
       <platform>Mac</platform>
       <platform>Linux/GTK</platform>
     </platforms>
   </node>
 </marketplace>
  • marketplace
    • node
      • (@attribute) id: [int] Unique identifier
      • (@attribute) name: [string] Listing Title
      • (@attribute) url: [string] Listing Url
      • type: [string] This is the type of listing being returned. 'training' is for a Training and Consulting Listing, 'resource' is for a solutions listing.
      • categories
        • category
          • (@attribute) id: [int] Unique identifier
          • (@attribute) name: [string] Title
          • (@attribute) url: [string] Url
      • tags
        • tag
          • (@attribute) id: [int] Unique identifier
          • (@attribute) name: [string] Title
          • (@attribute) url: [string] Url
      • owner: [string] Name of the author
      • favorited: [int] Number of times a listing was favorited
      • installstotal: [int] Install count
      • installsrecent: [int] Install count for the last month
      • shortdescription: [string] Listing teaser
      • body: [sting] Full description
      • created: [int] Timestamp
      • changed: [int] Timestamp
      • foundationmember: [bool] TRUE/FALSE
      • homepageurl: [string] Listing URL website
      • image: [string] Logo absolute URL
      • license: [string] Listing license
      • companyname: [string] Company name
      • status: [string] Release status
      • supporturl: [string] Support/documentation URL
      • version: [string] Version name
      • eclipseversion: [float] Eclipse release number (4.5, 4.4...)
      • updateurl: [string] Update site URL
      • ius: Feature ID's are used by the Eclipse Marketplace Client (MPC) to determine which features to install for your listing https://marketplace-staging.eclipse.org/feature-how-to
        • iu
          • (@attribute) required: [string] TRUE or FALSE
          • (@attribute) selected: [string] TRUE or FALSE
      • platforms
        • platform: [string] Compatible OS (Windows, Mac, Linux/GTK)

Examples

Returning Search Results

http://marketplace.eclipse.org/api/p/search/apachesolr_search/[query]?page_num=[page num]&filters=[filters]

There is one exception to using the api/p at the end of URLs. The search API needs this string to be at the start of the URL.

URL Variables


XML example 

 <marketplace>
   <search term="test" url="http://marketplace-staging.eclipse.org/search/content/test" count="1">
     <node>Please refer to Returning a Specific Listing section.</node>
   </search>
 </marketplace>

Featured Listings

http://marketplace.eclipse.org/featured/api/p

This call will return a list of Featured Listings. By default this returns 6 listings. The default is configured on the server.

If available, it can insert up-to two promoted downloads at the top of the list. It is possible to see a commercial listing here.


http://marketplace.eclipse.org/featured/%/api/p

This call will return a list of featured listings constrained by a category / market id (or both). By default this returns 10 listings. The default is configured on the server. It is possible to use page_num to paginate through the results.

Example:

XML example 

 <marketplace>
   <featured count="10">
     <node>Please refer to Returning a Specific Listing section.</node>
   </featured>
 </marketplace>

Recently Updated Listings

http://marketplace.eclipse.org/recent/api/p

This call will return a list of Recently Updated or Added Listings. By default this returns 6 listings. The default is configured on the server. It is possible to use page_num to paginate through the results.

XML example 

 <marketplace>
   <recent count="10">
     <node>Please refer to Returning a Specific Listing section.</node>
   </recent>
 </marketplace>

Top Favorited Listings

http://marketplace.eclipse.org/favorites/top/api/p

This call will return a list of the Most Favorited Listings. By default this returns 6 listings. The default is configured on the server. It is possible to use page_num to paginate through the results.

XML example 

 <marketplace>
   <favorites count="10">
     <node>Please refer to Returning a Specific Listing section.</node>
   </favorites>
 </marketplace>

Most Popular Listings

http://marketplace.eclipse.org/popular/top/api/p

This call will return a list of Most Popular listing by activity. By default this returns 6 listings. The default is configured on the server. It is possible to use page_num to paginate through the results.

XML example 

 <marketplace>
   <popular count="10">
     <node>Please refer to Returning a Specific Listing section.</node>
   </recent>
 </marketplace>

Related Entries

http://marketplace.eclipse.org/related/api/p

This call will return a list of entries related to what's already installed in the running Eclipse. Installed entries are sent to the server as node ids in an additional query parameter

nodes: A list of space-separated node ids for installed marketplace nodes, url-encoded.

Example:

http://marketplace.eclipse.org/related/api/p?nodes=12345+23456+34567

This feature is already supported by the MPC client through a 'Related' tab that needs to be enabled in the catalog's branding information, see Catalog Description. The server at marketplace.eclipse.org does not yet support this query at the moment, see bug 453244.

Catalogs

What is a Catalog

A catalog is an HTTP service which returns XML data back to the Marketplace Client from. Currently Marketplace uses PHP with an SQL backend to serve these pages to the MPC.

Building a Catalog

In terms of building your own catalog with this data you would follow a three step process.

  1. Query the Base URL for a listing of Markets and their categories.
  2. Iterate through that query to retrieve listings for each category using the Category URL.
  3. Finally iterate through the Category Query to retrieve the data related to each node.

Catalog Description

Catalogs are managed through a registry on marketplace.eclipse.org. Each catalog is listed with its REST URL and branding information (Title, catalog icon, MPC wizard icon, supported MPC tabs).

A list of catalogs can be retrieved from http://marketplace.eclipse.org/catalogs/api/p

XML Example 

  <marketplace>
    <catalogs>
      <catalog id="38413" title="Eclipse Marketplace" url="http://marketplace.eclipse.org" selfContained="0"
               icon="http://marketplace.eclipse.org/sites/default/files/marketplace_catalog_icon-32.png">
        <description>
          Eclipse Marketplace (MP) is a place to find and keep track of Eclipse-based solutions.
        </description>
        <dependenciesRepository/>
        <wizard title="">
          <icon>http://marketplace.eclipse.org/sites/default/files/marketplace_catalog_icon_0.png</icon>
          <searchtab enabled="1">Search</searchtab>
          <featuredmarkettab enabled="1">Eclipse Project</featuredmarkettab>
          <populartab enabled="1">Popular</populartab>
          <recenttab enabled="1">Recent</recenttab>
          <relatedtab enabled="1">Related</relatedtab>
          <news shorttitle="March 05/26" timestamp="1432612800">https://www.eclipse.org/community/eclipse_newsletter/2015/may</news>
        </wizard>
      </catalog>
    </catalogs>
  </marketplace>

News Page

Since MPC Kepler, it's possible to add an additional tab containing an embedded browser component that shows a news page. The page URL to display will be included in the marketplace catalog description pulled from the server. It's possible to override a catalog default URL with news/api/p.

Here's an example of the default Eclipse Marketplace catalog news page: http://marketplace.eclipse.org/news/api/p

Marketplace Client

The Marketplace Client (MPC) project implements a client to the REST API. The client provides public Java API for accessing the REST API in the org.eclipse.epp.mpc.core plug-in through the classes in the org.eclipse.epp.mpc.core.service package.

Of interest to clients to the REST API:

  • IMarketplaceServiceLocator is an OSGi service that can be used as an entry point to access the catalog service and specific marketplace services.
  • IMarketplaceService gives access to the marketplace REST API
  • ICatalogService gives access to the catalog registry
  • The marketplace data model is available through interfaces in the org.eclipse.epp.mpc.model package.

In addition to the Java REST API, there is also some API to access the Marketplace Client wizard dialog in the org.eclipse.epp.mpc.ui plug-in:

  • MarketplaceClient offers some simple helper methods to open a wizard and to give access to the more elaborate IMarketplaceClientService
  • IMarketplaceClientService offers more elaborate configuration options to open a wizard in a specific state, e.g. with specific markets, entries preselected for install, or directly on the installation page.

Furthermore, of interest to catalog providers or implementors of client libraries to access the REST API in MPC:

  • /org.eclipse.epp.mpc.core/mpc-rest.xsd An XML Schema that describes the REST API data format
  • org.eclipse.epp.internal.mpc.core.service.DefaultMarketplaceService A Java class that provides a Java API to the REST service
  • org.eclipse.epp.mpc.tests.service.DefaultMarketplaceServiceTest A JUnit test case that exercises the REST API
Retrieved from "https://wiki.eclipse.org/index.php?title=Marketplace/REST&oldid=447951"

This page was last modified 19:32, 6 November 2023 by Théodore Biadala. Based on work by Christopher Guindon, Carsten Reckord and Ed Merks and others.

Back to the top