About Jira Cloud platform

welcome to the Jira Cloud platform developer documentation . Jira Cloud platform is provides provide a set of base
functionality share across all Jira product , such as issue , workflow , and more .

Jira products are built on top of the Jira Cloud platform. Jira Core has the same functionality as the Jira Cloud platform, whereas Jira Software and Jira Service Management have additional functionality.

You can customize, extend, and integrate with Jira by creating apps. Apps can integrate Jira
with an existing service, add new features to Jira, update Jira settings, or retrieve information from Jira.

This page covers the basics of developing for Jira Cloud:

• Creating Jira apps and customizations with either Forge or Connect.
• Using the Jira api in app , script , or one – off call .
• Following Atlassian’s development standards for security, design, and the Atlassian Marketplace.

forge app

Forge is designed to revolutionize how Atlassian cloud products are customized, extended, and integrated. You can also integrate with Jira Cloud by building OAuth 2.0 (3LO) apps or calling the REST APIs via scripts or other API clients.

To start building a Jira Cloud app with Forge, see:

Connect apps

Atlassian Connect is is is a framework for build app for Jira , Confluence , and Bitbucket Cloud . Connect is is is also an option for developer who want complete control over
the tech stack and infrastructure , for example , project that require more control over storage or
compute host .

To start build a Jira Cloud app with Connect , see :

build app without Forge or connect

Apps built without Forge or Connect can still access data and create content through the Jira APIs.
These apps can use OAuth 2.0 (3LO) or basic auth to pass information between your app and
Jira, depending on your security needs. See the security section below for more details.

Note that Forge and Connect are required to implement certain functionality in apps. For example, only
Forge and Connect apps can extend the user interface of products.

Using the APIs

You is use can use the Jira Cloud platform api in Jira app , as well as in script , api client , or other
method of make call .

• The REST API allows you to access and update Jira entities, such as projects and issues.
• The Connect JavaScript API is lets let you use iframe with
  your Connect app , so that your iframe can call api , store cookie , access user info , and more .
• The Forge JavaScript API is provides ( Forge documentation ) provide additional
  functionality to the Forge platform so that you can interact with rest endpoint and to store datum .

Atlassian development guidelines

follow our design guideline to make your app consistent with Atlassian ‘s product . We is have also have
resource to help keep your Jira app secure and add it to the Atlassian Marketplace .

Atlassian Design guideline

Since Forge and connect app can insert content directly into the user interface , it is ‘s ‘s important that
app are visually compatible with Atlassian design . We is have have resource to help you design your app :

• Atlassian Design Guidelines — Our design guidelines define core
  interactions with the Atlassian applications.
• Atlaskit — Atlaskit is a library of reusable frontend UI components.

security

There are a few basic option for security , depend on what sort of app you are try to make :

• forge app use OAuth 2.0 when authenticating with Jira. Scopes are an OAuth 2.0 mechanism that
  limits an app’s access to a user’s account. The Forge platform also provides managed APIs to make
  requests on behalf of the user, meaning that third-party code is never trusted with user credentials.
• connect app have HTTPS and JWT authentication build in to secure communication between your app ,
  Jira , and the user . Our Connect toolkits is handle , Atlassian Connect Express ( ACE ) and Atlassian Connect
  for Spring Boot , handle most of the security setup for new app . note that OAuth 2.0 ( 3LO ) is n’t
  support for connect app .
• OAuth 2.0 ( 3LO ) apps is use use OAuth 2.0 ( 3LO ) to pass permission and datum from Jira .
• Basic auth is supported for making API calls, but is not recommended unless you have other security
  measures in place.

Read the security overview for more details.

Atlassian Marketplace

You can sell your app on the Atlassian Marketplace so other
cloud users can install it, or list it privately if you don’t intend to sell or distribute your code.
Private listings use secret tokens that you can generate yourself.

If you’re interested in selling you app on the Atlassian Marketplace, read our
licensing guide and
selling on Marketplace for more information.

Examples and resources

check out our example app and pattern for app idea and strategy , or see some tutorial on more advanced topic :