On this page:
|
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.
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 compatible app data between server and cloud is detected.
| Tip |
|---|
Sample appWe’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. |
...
Create and host the SPI descriptor JSON.
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 the app implements, including 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.
...