The Atlassian Marketplace API: stable, feature-rich, and documented!

Today at AtlasCamp, we announced the latest version of our Atlassian Marketplace API. This REST API is stable, supported, provides the ability to access and manage multiple aspects of add-on listings and vendor businesses, and best of all - is fully documented.

What can the API do for me?

This REST API is designed to integrate Atlassian Marketplace directly into your business process and tooling. Let's look at an example API usage. One of the simplest ways to use the API is to retrieve an add-on's details. We can do so with the following cURL command:

# Get the details for "Portfolio for JIRA", along with the current version
curl "https://marketplace.atlassian.com/rest/2/addons/com.radiantminds.roadmaps-jira?withVersion=true"

What about something more useful, for example, a request to get a list of all licenses for customers who have recently purchased your add-ons:

# Get a vendor's add-on licenses which have been updated (purchased, renewed, etc.) on or after a specified date.
# Note: this request requires a valid username, password, vendor id and a date
curl -u USERNAME:PASSWORD "https://marketplace.atlassian.com/rest/2/vendors/VENDOR_ID/reporting/licenses?lastUpdated=YYYY-MM-DD"

It gets even better! The licenses resource from this example supports a number of request parameters to allow for advanced license searching. Keep reading to find out more about these parameters and how to use them.

That's just the start.

Is the API easy to use?

Yes, this REST API is easy to use for a number of reasons. First of all, it follows the HAL specification to provide clear and consistent behavior. Most notably, the API's responses include link maps (_links) to reference related resources and embedded representations (_embedded) to clearly denote when sets of properties belong to a different-yet-related object.

Using the link maps, clients can easily navigate between resources to access all of the desired data. Additionally, resources which support a number of optional request parameters will be represented as link templates to provide a programmatic interface with which clients can determine how to use it.

As with most REST APIs, you're free to use your favorite REST client; my favorites are Chrome's Postman and cURL. Alternatively, if you're accessing the API in a JVM-based language, you can use the Marketplace Java client.

And of course, the API is now finalized and stable — meaning that you can build on top of it with confidence.

Where can I get started?

You can access the API directly and navigate through the links map. Just use a browser or your favorite REST client. Alternatively, you can view our extensive API documentation.

The majority of our documentation is structured with detailed information about request and response formats. This part of our documentation is built with Swagger and deployed with RADAR, a new API documentation generator that we've built to present this and other Atlassian APIs. Additionally, we have open-sourced RADAR as part of joining the Open API Initiative.

Lastly, you can follow the tutorials to learn more about how to use the Marketplace API.

What about the previous API version?

Version 1.0 of the Atlassian Marketplace API will remain stable and accessible. However, future improvements and bug fixes may only apply to the newer version.

We hope that you try out the new API! Please provide us with any feedback that you have in the Marketplace team's JIRA project.