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

Difference between revisions of "Marketplace/REST"

(→‎Compatibility Tests)
Line 1: Line 1:
−
== Eclipse Marketplace REST API Documentation ==
+
= Eclipse Marketplace REST API Documentation =
  
−
==== Provisional API<br>  ====
+
== General Usage ==
  
−
The Eclipse Marketplace API is currently in a provisional state. The URLs for the API calls may change at any time.
+
This API is identified by 'api/p' at the end of most URLs.<br>
−
 
+
−
This provisional API is identified by 'api/p' at the end of most URLs.<br>  
+
  
 
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.
 
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.
  
−
<br>  
+
We only returns listings that don't have a commercial license for the Recently Updated Listings, Top Favorited Listings & Most Popular Listings''' API calls.
 +
 
 +
=== URL Variables ===
 +
 
 +
*''' client ''': The only valid value for the client variable is <code>org.eclipse.epp.mpc.core</code>. 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.
 +
 
 +
Example: http://marketplace.eclipse.org/featured/api/p?client=org.eclipse.epp.mpc.core
 +
 
 +
 
 +
== 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. Older MPC versions instead use the parameter 'runtime.version' with the version of the org.eclipse.core.runtime bundle. The server will use this as a fall-back if 'platform.version' is not available.
 +
 
 +
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.
 +
 
 +
=== URL Variables ===
 +
 
 +
* os: [string] Operating system of the user. Valid values are "linux", "windows" and "macosx".
 +
* platform_version: [float] The version of the org.eclipse.platform bundle of the target Eclipse:
 +
** '''4.5''' (Mars)
 +
** '''4.4''' (Luna)
 +
** '''4.3''' (Kepler)
 +
** '''4.2''' (Juno)
 +
** '''4.1''' (Previous to Juno)
 +
 
 +
Example: http://marketplace-staging.eclipse.org/content/test-entry-juno/api/p?os=win32&platform_version=4.2
 +
 
  
−
==== Retrieving a listing of all catalogs ====
+
== Retrieving a listing of all catalogs ==
  
 
http://marketplace.eclipse.org/catalogs/api/p
 
http://marketplace.eclipse.org/catalogs/api/p
Line 22: Line 52:
  
  
−
==== Retrieving A listing of Markets and Categories<br>  ====
+
''' XML example '''
  
−
http://marketplace.eclipse.org/api/p
+
  <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>
  
−
This will return a listing of Markets and Categories, it includes URLs for each category, as well number of listings in each category.  
+
*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
  
−
==== Retrieving a set of listings from a specific Market / Category <br>  ====
+
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 ==
  
 
<nowiki>http://markerplace.eclipse.org/taxonomy/term/[category id],[market id]/api/p</nowiki>
 
<nowiki>http://markerplace.eclipse.org/taxonomy/term/[category id],[market id]/api/p</nowiki>
  
−
This call returns a set of listings that correspond to the category / market specified.  
+
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.  
+
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  
+
http://marketplace.eclipse.org/taxonomy/term/4,31/api/p
  
 
These urls are easily obtained from using the http://marketplace.eclipse.org/api/p call.
 
These urls are easily obtained from using the http://marketplace.eclipse.org/api/p call.
  
−
==== Returning a Specific Listing<br>  ====
 
  
−
There are two methods of returning a specific listing.  
+
''' 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.
  
 
<nowiki>http://marketplace.eclipse.org/content/[title]/api/p </nowiki>
 
<nowiki>http://marketplace.eclipse.org/content/[title]/api/p </nowiki>
  
−
and  
+
and
  
 
<nowiki>http://marketplace.eclipse.org/node/[node id]/api/p </nowiki>
 
<nowiki>http://marketplace.eclipse.org/node/[node id]/api/p </nowiki>
  
−
Calls to either URL will return a listing of contents of a node.<br>  
+
Calls to either URL will return a listing of contents of a node.<br>
 +
 
 +
 
 +
''' 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
 +
****(@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 licence
 +
***'''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 ===
  
−
*You will need to supply the value in the URL for [title] or [node id]. These URLS will be provided in full by queries to return a subset of listings such as Categories, Searches, Featured etc.
+
*example: http://marketplace.eclipse.org/node/51/api/p will return a Training and Consulting Listing<br>
−
*Most fields in the XML document are self explanitory. However there are a few fields that require explanation.<br>
+
−
*Type - this is the type of listing being returned. 'training' is for a Training and Consulting Listing, 'resource' is for a solutions listing.<br>
+
−
*Body - this field can and most likely contains HTML markup. This also applies to the Training and Consulting Fields (trainingdesc and consultingdesc)<br>
+
−
*Created - this field is when the listing was first created. It is the number of seconds since the epoch. See http://us.php.net/manual/en/function.time.php for more details.<br>
+
−
*Changed - this field is the last time this listing was changed. It is the number of seconds since the epoch. See http://us.php.net/manual/en/function.time.php for more details.<br>
+
−
*FoundationMember - this is a boolean field. 0 meaning No, 1 meaning Yes.<br>
+
−
*example: http://marketplace.eclipse.org/node/51/api/p will return a Training and Consulting Listing<br>  
+
 
*example: http://marketplace.eclipse.org/content/subclipse/api/p will return a Solutions Listing. <br>
 
*example: http://marketplace.eclipse.org/content/subclipse/api/p will return a Solutions Listing. <br>
  
−
==== Returning Search Results <br>  ====
+
== Returning Search Results ==
  
 
<nowiki>http://marketplace.eclipse.org/api/p/search/apachesolr_search/[query]?page_num=[page num]&amp;filters=[filters] </nowiki>
 
<nowiki>http://marketplace.eclipse.org/api/p/search/apachesolr_search/[query]?page_num=[page num]&amp;filters=[filters] </nowiki>
Line 70: Line 266:
 
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.
 
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 <br> =====
+
=== URL Variables ===
  
−
[query] - This is the string you wish to query the database with  
+
*'''query''': This is the string you wish to query the database with
 +
*'''page num''': The search API returns 10 results per page. Use this parameter to iterate though pages. The root node will always return the total number of results.
 +
*'''filters''': There are 3 different filters used by the Apache Solr search database that can be used to constrain (Facet) your searches. If you plan to use more then one filter they must be '''SPACE''' separated.
 +
*'''tid''': This field is the database equivalent of category IDs.
 +
**Example: http://marketplace.eclipse.org/api/p/search/apachesolr_search/enterprise?filters=tid:9 tid:31 This query would search for 'Enterprise' in the J2EE category of the Tools Market.
 +
*'''sm_field_status''': this filter is the equivalent of the &lt;status&gt; tag in a listings XML result.
 +
**Example: http://marketplace.eclipse.org/api/p/search/apachesolr_search/enterprise?filters=sm_field_status:Production%2FStable This query would search for 'Enterprise' listings that have a Status matching 'Production/Stable'
 +
*'''sm_field_licensetype''': this filter is the equivalent of the &lt;license&gt; tag in the listings XML result.
 +
**Example: http://marketplace.eclipse.org/api/p/search/apachesolr_search/enterprise?filters=sm_field_licensetype:Free EPL' This query would search for 'Enterprise' listings that have a License Type matching "Free EPL".
  
−
[page num] - The search API returns 10 results per page. Use this parameter to iterate though pages. The root node will always return the total number of results.
 
  
−
[filters] - There are 3 different filters used by the Apache Solr search database that can be used to constrain (Facet) your searches. If you plan to use more then one filter they must be '''SPACE''' separated.
+
''' XML example '''
  
−
*tid - This field is the database equivalent of category IDs.
+
  <marketplace>
 +
    <search term="test" url="http://marketplace-staging.eclipse.org/search/content/test" count="1">
 +
      <node>[[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]</node>
 +
    </search>
 +
  </marketplace>
  
−
Example&nbsp;: http://marketplace.eclipse.org/api/p/search/apachesolr_search/enterprise?filters=tid:9 tid:31 This query would search for 'Enterprise' in the J2EE category of the Tools Market.  
+
*marketplace
 +
**search
 +
***(@attribute) '''term''': [string] Search keyword
 +
***(@attribute) '''url''': [string] Url
 +
***(@attribute) '''count''': [int] Result count
 +
***node: [[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]
  
−
*sm_field_status - this filter is the equivalent of the &lt;status&gt; tag in a listings XML result.
+
== Featured Listings ==
  
−
Example&nbsp;: http://marketplace.eclipse.org/api/p/search/apachesolr_search/enterprise?filters=sm_field_status:Production%2FStable This query would search for 'Enterprise' listings that have a Status matching 'Production/Stable'
+
http://marketplace.eclipse.org/featured/api/p
  
−
*sm_field_licensetype - this filter is the equivalent of the &lt;license&gt; tag in the listings XML result.
+
This call will return a list of Featured Listings. By default this returns 6 listings. The default is configured on the server.
  
−
Example&nbsp;: http://marketplace.eclipse.org/api/p/search/apachesolr_search/enterprise?filters=sm_field_licensetype:Free EPL' This query would search for 'Enterprise' listings that have a License Type matching "Free EPL".
+
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.
  
−
==== Featured Listings  ====
+
<br> http://marketplace.eclipse.org/featured/%/api/p
  
−
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 6 listings. The default is configured on the server.
  
−
This call will return a list of Featured Listings. By default this returns 6 listings. The default is configured on the server.
+
Example:
  
−
<br> http://marketplace.eclipse.org/featured/%/api/p  
+
*http://marketplace.eclipse.org/featured/2/api/p - This call will return featured items from the Code Management (ID = 2) Category.
 +
*http://marketplace.eclipse.org/featured/31/api/p - This call will return featured items from the Tools (ID = 31) Market.
 +
*http://marketplace.eclipse.org/featured/2,31/api/p - This call will return featured items that are contained in both the Code Management and Tools categories.
  
−
This call will return a list of featured listings constrained by a category / market id (or both). By default this returns 6 listings. The default is configured on the server.
+
''' XML example '''
  
−
Example:
+
  <marketplace>
 +
    <featured count="10">
 +
      <node>[[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]</node>
 +
    </featured>
 +
  </marketplace>
  
−
*http://marketplace.eclipse.org/featured/2/api/p - This call will return featured items from the Code Management (ID = 2) Category.
+
*marketplace
−
*http://marketplace.eclipse.org/featured/31/api/p - This call will return featured items from the Tools (ID = 31) Market.
+
**featured
−
*http://marketplace.eclipse.org/featured/2,31/api/p - This call will return featured items that are contained in both the Code Management and Tools categories.
+
***(@attribute) '''count''': [int] Result count
 +
***node: [[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]
  
−
<br/>
+
== Recently Updated Listings ==
−
 
+
−
==== Recently Updated Listings ====
+
  
 
http://marketplace.eclipse.org/recent/api/p
 
http://marketplace.eclipse.org/recent/api/p
Line 114: Line 331:
 
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.
 
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.
  
 +
''' XML example '''
 +
 +
  <marketplace>
 +
    <recent count="10">
 +
      <node>[[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]</node>
 +
    </recent>
 +
  </marketplace>
 +
 +
*marketplace
 +
**recent
 +
***(@attribute) '''count''': [int] Result count
 +
***node: [[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]
  
−
==== Top Favorited Listings ====
+
== Top Favorited Listings ==
  
 
http://marketplace.eclipse.org/favorites/top/api/p
 
http://marketplace.eclipse.org/favorites/top/api/p
Line 121: Line 350:
 
This call will return a list of the Most Favorited Listings.  By default this returns 6 listings.  The default is configured on the server.
 
This call will return a list of the Most Favorited Listings.  By default this returns 6 listings.  The default is configured on the server.
  
 +
''' XML example '''
  
−
==== Most Popular Listings ====
+
  <marketplace>
 +
    <favorites count="10">
 +
      <node>[[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]</node>
 +
    </favorites>
 +
  </marketplace>
 +
 
 +
*marketplace
 +
**favorites
 +
***(@attribute) '''count''': [int] Result count
 +
***node: [[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]
 +
 
 +
== Most Popular Listings ==
  
 
http://marketplace.eclipse.org/popular/top/api/p
 
http://marketplace.eclipse.org/popular/top/api/p
Line 128: Line 369:
 
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.
 
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.
  
 +
''' XML example '''
  
−
==== Compatibility Filtering & Multiple Versions per Solution ====
+
  <marketplace>
 +
    <popular count="10">
 +
      <node>[[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]</node>
 +
    </recent>
 +
  </marketplace>
  
−
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).
+
*marketplace
−
 
+
**popular
−
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. Older MPC versions instead use the parameter 'runtime.version' with the version of the org.eclipse.core.runtime bundle. The server will use this as a fall-back if 'platform.version' is not available.
+
***(@attribute) '''count''': [int] Result count
−
 
+
***node: [[Marketplace/REST#Returning_a_Specific_Listing|Please refer to Returning a Specific Listing section.]]
−
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 <br> =====
+
−
 
+
−
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.
+
−
 
+
−
==== URL Variables <br> ====
+
−
 
+
−
[client] - 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.
+
−
 
+
−
'''Featured Listings''' : 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.
+
−
 
+
−
'''Recently Updated Listings, Top Favorited Listings & Most Popular Listings''': Only returns listings that don't have a commercial license.
+
−
 
+
−
Example: http://marketplace.eclipse.org/featured/api/p?client=org.eclipse.epp.mpc.core
+
  
 
= Catalogs =
 
= Catalogs =
Line 168: Line 399:
  
 
Here's an example of the default Eclipse Marketplace catalog news page: http://marketplace.eclipse.org/news/api/p
 
Here's an example of the default Eclipse Marketplace catalog news page: http://marketplace.eclipse.org/news/api/p
 +
  
 
= Marketplace Client =
 
= Marketplace Client =

Revision as of 16:18, 23 March 2015

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 that don't have a commercial license for the Recently Updated Listings, Top Favorited Listings & Most Popular Listings API calls.

URL Variables

  • client : 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.

Example: http://marketplace.eclipse.org/featured/api/p?client=org.eclipse.epp.mpc.core


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. Older MPC versions instead use the parameter 'runtime.version' with the version of the org.eclipse.core.runtime bundle. The server will use this as a fall-back if 'platform.version' is not available.

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.

URL Variables

  • os: [string] Operating system of the user. Valid values are "linux", "windows" and "macosx".
  • platform_version: [float] The version of the org.eclipse.platform bundle of the target Eclipse:
    • 4.5 (Mars)
    • 4.4 (Luna)
    • 4.3 (Kepler)
    • 4.2 (Juno)
    • 4.1 (Previous to Juno)

Example: http://marketplace-staging.eclipse.org/content/test-entry-juno/api/p?os=win32&platform_version=4.2


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

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
        • (@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 licence
      • 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 6 listings. The default is configured on the server.

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.

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.

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.

XML example 

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

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.

News Page

For MPC Kepler, it's going to be 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. Though the client does not provide public Java API for accessing the REST API, it may be useful for testing purposes when building a catalog.

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=380500"

Back to the top