Installing a Jira Cloud Plugin from the Atlassian Marketplace

This guide provides a step-by-step approach to installing https://marketplace.atlassian.com/apps/1221580/rest-api-browser-for-jira-and-confluence-cloud?hosting=cloud&tab=overview from the Atlassian Marketplace.

Prerequisites

1. Jira Cloud Admin Access

   • You must be a Jira Administrator or Organization Admin to install apps from the Atlassian Marketplace.

2. Active Atlassian Account

   • Ensure you are logged in to Jira Cloud with an account that has the necessary permissions.

---

Installation Steps

1. Access the Atlassian Marketplace

• Open Jira Cloud in your browser.

• Click on the Apps menu in the top navigation bar.

• Select Find new apps to open the Atlassian Marketplace.

2. Search for the Plugin

• In the search bar, enter the name of the Jira Cloud Plugin you want to install.

• Click on the app name in the search results to view its details.

3. Install the Plugin

• Click the Try it free or Get app button.

• If the app offers a free trial, Jira will notify you about the trial period.

• Click Start free trial or Install to proceed.

4. Grant Necessary Permissions

• Some apps require additional permissions to access Jira data.

• Review the permissions requested by the app.

• Click Accept & Install to confirm.

5. Wait for Installation Completion

• Jira will display a progress bar indicating the installation status.

• Once installed, you may see a confirmation message.

---

Post-Installation Configuration

1. Navigate to the Installed App

   • Go to Apps > Manage apps.

   • Locate the installed app in the list.

   • Click on the app name to access its settings.

2. Adjust App-Specific Settings

   • Some apps require additional setup.

   • Follow the app’s documentation or setup wizard (if available).

3. Assign Permissions (If Required)

   • Some apps require admin configuration to define user access.

   • Go to Jira Settings > Global Permissions or App-Specific Permissions.

4. Verify Functionality

   • Test the app by navigating to its features in Jira (e.g., issue panels, dashboards, reports).

---

Managing & Uninstalling Plugins

To Manage an Installed App

• Go to Apps > Manage apps.

• Click on the app name.

• Adjust settings or disable the app if needed.

To Uninstall an App

• Locate the app under Manage apps.

• Click the Actions button (⋮).

• Select Uninstall and confirm.

---

Troubleshooting Installation Issues

Using the application

Accessing the REST Browser Application

The application is available from the menu Apps - where you need to navigate down to the REST Api Browser Button and click on it to access the application:

Selecting API Documentation in the REST API Browser

The REST API Browser for Atlassian Cloud Apps (REST API Browser for Jira and Confluence Cloud) allows users to explore different API documentation sets through a dropdown menu in the right-hand panel.

Choosing an API Documentation Set

On the right-hand side of the interface, a Docs section contains a dropdown menu where users can select the relevant API documentation with the version version. The available options may include:

• Jira Cloud Platform V2 (stable)

• Jira Cloud Platform V3

• Jira Software Cloud

• Jira Service Desk Cloud

• Confluence Cloud

• Trello

• Cloud Admin

How to Use the API Selection Menu

1. Click on the dropdown menu in the Docs section.

2. Select the appropriate API documentation set based on your requirements.

3. Once selected, the REST API Browser will display the relevant API endpoints, categorized for easy navigation.

Testing API Endpoints

The plugin provides users with the ability to interact with real instances of the Atlassian Cloud applications by testing various API endpoints directly from the plugin UI.

Key Features:

• Users can click the button “Try this API“ and enter the URL of the endpoint they wish to test.

• The appropriate API method can be selected from the available options: GET, POST, PUT, or DELETE.

• Upon sending the request by clicking the Send button, the response code and payload will be displayed in a dedicated window below the URL input field, providing immediate feedback on the request execution.

This functionality allows users to validate API interactions efficiently without requiring external tools, ensuring a streamlined testing process within the plugin itself.

• The results can be copied to the clipboard for easy sharing and further analysis.

• For improved readability, the response data can be immediately formatted as JSON, ensuring a clear and structured presentation.

Using Special Headers

When sending a request to an API endpoint, users have the option to enable the X-ExperimentalApi header. This allows access to experimental API features that may not yet be part of the standard API.

For more details on special headers and their usage, please refer to the official documentation, for example for JSD it’s here: Atlassian Special Headers

The plugin includes a search functionality that allows users to quickly find relevant documents. Additionally, a history feature keeps track of previous search inputs and responses, enabling users to easily revisit past queries and results for reference.

Support and Assistance

For any questions regarding the plugin’s user interface, functionality, or features, please feel free to contact the development team at support@glsolutions.cz. The support team is available to assist with any inquiries or issues.