Integrate Cloud Apps with Cloud SPI

Owned by Rosen Marinkov
Last updated: Nov 06, 2023
2 min read

 

Who can use this information?
Follow these instructions if you’re an app vendor, developer, or Jira user integrating a Jira Cloud Connect app with Configuration Manager for Jira (CMJ) Cloud through the Service Provider Interface.

 

On this page:

API Reference

If you need more technical information on the latest OpenAPI specs of the Cloud SPI, follow the link to read the complete API reference.

Integrate your Connect app with the Cloud SPI

Connect apps are cloud apps developed with Atlassian’s Connect framework. The SPI for Jira Cloud is a set of OpenAPI REST interfaces implemented by Connect Apps. Configuration Manager for Jira Cloud invokes it during migration when app data that is compatible between server and cloud is detected.

Sample app

We’ve developed a sample app and integrated it with the Cloud SPI. It will show you in practice how to make the initial setup and implement a Cloud SPI endpoint. You can find the sample app in our public repository.

Throughout our documentation, we will refer to the SPI for CMJ Cloud as Cloud SPI or CMJ Cloud SPI.

To integrate your app to CMJ using the Cloud SPI, follow these steps:

  1. Create and host the SPI descriptor JSON.

  2. Implement app-specific REST endpoints of the Cloud SPI.

Step 1: Initial SPI setup

Create and host the SPI Descriptor JSON. This JSON describes the different SPI endpoints that the app implements - their location and configuration.

Step 2: Implement app-specific SPI endpoints

Next, implement the Cloud SPI’s endpoints from the list below for the types of configurations your app includes. For example, if your app deals with workflows or modifying workflows in Jira, you will need to implement the Workflows SPI endpoint.

  1. Implement the SPI REST endpoints. Take care of Authentication.

  2. In the implemented endpoints, invoke the CMJ Cloud Operations API to report progress and result or get configuration mappings.

Cloud SPI endpoints

The following endpoints are currently supported (more endpoints to come):

License

The Configuration Manager SPI is licensed under the Creative Commons license (CC BY 4.0).