Connecting to the Jira API in Appsmith

1. Enable the Jira API and Create an API Key

   
   1. Login to Jira and go to Account > Security > Manage API Tokens 
   2. Click Create API Token and enter a name
   3. Copy the token (WARNING - you can only view this once!)
   4. Save it somewhere safe for the next step

2. Create a Basic Token with your email address

   The Jira API uses an authentication header that consists of the user's email and the API Key separated by a : colon, and base64 encoded. This can be done in Appsmith or any JavaScript environment using the btoa() method. Or you can use an online tool like base64encode.org. Then this new base64 encoded value will be used in the Authorization header. 

   Authorization: Basic (email:API_KEY) <== Base64Encoded
    

   
   

    

3. Create a Datasource in Appsmith

   Now that you have the Jira API enabled, an API Key created, and a Basic Token generated, you can use that to create an Authenticated API Datasource in Appsmith. This will save the token on the Appsmith server so that it is never exposed on the client side, even for other app editors and admins. 

   In a new or existing Appsmith app, click the (+) to add a new datasource and choose Authenticated API. Then fill out the form as follows:

   Jira Authenticated API Datasource Configuration - Basic Auth

   Datasource Setting	Value	Notes
   Name	Jira API-Joseph	Helps to include name of API provider, and account owner
   Url	https://appsmith-test.atlassian.net/rest/api/3/	replace with your subdomain
   Authentication Type	API Key
   Authentication > Key	Authorization	This is the header key
   Authentication > Value	**The base64 encoded email:API_KEY**	Note the encrypted field 🔐 indicating it will be stored securely on the server
   Authentication > Add to	Header
   Header prefix	Basic

   Save the Datasource. 

   With an Authenticated API Datasource configured, you can now begin to add new APIs that will all have proper authentication added in by the Appsmith server, without exposing the credentials to the client-side, even for you as the admin. 

   NOTE: If you go to edit the datasource, the encrypted fields will be blank, and must be re-entered before saving the datasource again. 

4. GET Projects from Jira

   Next, add a GET API for the new Jira Datasource, and configure it for the /project/search endpoint. 

    

   Click the ADD API on the Jira Datasource page, or click the (+) to add a new API/Query, then select the new Jira Datasource. Note how the URL is prefilled, and locked to the value set in the datasource setup. 

   To make a GET request to the Projects endpoint, just add project/search to the URL and click RUN. 

   

   NOTE: The API response can be accessed at searchProjects.data, but the actual records are nested, in the searchProjects.data.values array. 

5. Add a Table Widget for Projects

   Next, add a new Table widget and click the JS option for the Table Data. Then update the data binding to searchProjects.data.value.

   

6. Add APIs for Other Methods and Endpoints

   You can continue to add new APIs for other methods, like PATCH (update) or DELETE, or other endpoints, in Jira to manage Issues, Users, or other resources. Just use the Jira REST API docs to find the endpoint you want use, then create the new API under your Jira Datasource. 

   You can also use the Table widget for creating, editing, and deleting records in Jira! Check out this video for details on how to add, edit and delete rows using the Table widget. 

Conclusion

Additional Resources

• Integrate Jira with Zendesk in Appsmith
• Table Widget Docs
• Jira REST API Docs