This blog entry shows how we can use the Axway Integration Builder (IB) iPaaS to connect to an on-prem Jira instance. Keep an eye out for an upcoming blog post from Leor Brenman that covers connecting to the Jira SaaS solution.
Axway Application Integration and Jira OnPrem: I will cover how to:
- Use the Axway Integration Builder (IB) iPaaS to integrate and manage your Jira instance.
- Do some basic initial testing of the integration against the Jira REST APIs.
What is not covered in this blog:
Unlike many of my other blog posts, in this entry I am not configuring a developer account on Jira, but rather using our internal deployment as an endpoint. This is in large part due to this being the on-prem version of the solution, which is not so easy as SaaS solutions for getting a developer instance provisioned.
Other Considerations:
In this entry, I am working with the Jira on-prem solution. As a result, unlike with many SaaS offerings, authentication flows may vary depending on your enterprise’s configuration. The instance I am working with is using HTTP Basic (username/password) based auth.
What is Jira?
Jira by Atlassian is a product offered either as a SaaS or on-prem solution used for bug tracking and project management. Here at Axway, we use Jira for R&D tracking of product defect and enhancement resolution.
Integrate Jira OnPrem with Axway Integration Builder
- Log in to the Axway Platform and navigate to the IB Sandbox.
Under Connectors, search for “Jira on-prem” and choose to Authenticate.
- Fill out the fields in the authentication screen and click “Create Instance.”
- Name the Connector Instance as you see fit.
- Your Jira Site Address will be the protocol, hostname, and possibly be extended by a resource path as shown below. My configuration shown below uses the HTTP Basic authType, but your organizations may vary. More information on this can be found on the Atlassian Developer site.
- Username and Password will be the values you would enter to log in to the Web Portal.
Test the Jira OnPrem Integration in Axway Integration Builder
Navigate to your Jira Connector Instance API Docs. From here we can do some initial testing against the REST APIs to see how developers might start working with them. For my testing, I decided to play around with a practical use case. I wanted to figure out who owned one of our newer solution offerings so I could ask them a couple of questions. To do this, I decided to work with the Projects API and explore our Axway AMPLIFY Streams solution to find out who owned the new SaaS-based offering. Here is how I went about it.
First, I wanted to find the project to get more information on it and used the GET /projects API. This will give you a full listing of the projects you are managing in Jira. From here, I did a Ctrl + F in the Response Body (a useful feature!) to find the project I wanted and note the project id of 18620.
Response Body
- Now that I had the project ID, I could do a GET /project/{id}. This returned a plethora of information about the project, including the components. In the components section, I found “SaaS,” which had a URL for the description of the component. Following that, I was able to find:
- I was then able to follow that link to find the following field: “displayName”:”Allan Denis.” This let me know that if I had any questions on that component of our solution, I should reach out to Allan, who was CTO of Steamdata.io before we acquired them to enhance our Full Lifecycle API Management offering.
Conclusion
At this point, you should have a working Jira on-prem integration with Axway Application Integration through our Integration Builder solution, and an idea of how to test it. This could be integrated with other tools as an endpoint for opening new incidents or as a data source.
Stay tuned, enjoy and reach out if you have any questions, comments or concerns with this configuration or ideas for what I tackle next!
Read more articles from Daniel Wille.