REST API for Submitting Bugs?

[Kain]

Hello,

We are game developers who would like to allow consumers to submit bugs through our in-game UI instead of popping up a web browser. The use case would be to potentially have this ability on consoles.

We are aware of JIRA issue collector, but that does not support the use case we are trying to enable.

Is there such a thing as  submitting a bug via RESTful API?

[DPKJ · Accepted solution]

@Kain I don't see any problem submitting bug using rest api to jira.

It is just a matter of calling - https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-post

But the problem you will face are of security. I don't think you will like to embed  API Key of user in your game (this can be use by anyone to flood in your Jira).

The better solution will using Jira Service Desk. This product is made just for this use case.

[Kain]

Thank you. The API key would be hidden behind our AWS APIGateway, which can also have throttle control.

I can't find much information about how this would be done with Jira Service Desk. The important part of this is not depending on a web browser and not requiring the user to create a separate account. In essence, we want minimal friction on a user deciding to report a bug.

[DPKJ]

@Kain If your API Key are hidden, then you won't need service desk.

Approach I would use and suggest based on my understanding of your use case is as follows,

1. Call some service api from app
   1. This will contain details of bugs (may be logs, screenshots etc)
   2. If required, you can authenticate to this service using your existing application authentication
2. Configure jira project and user
   1. Having a separate project for user bugs will have lots of advantages in long run
   2. You can add additional custom fields if standard fields are not sufficient, for example
      1. customer identifier
      2. application version etc. 
   3. Configure an User to file all bugs from customer
      1. Generate API Key on behalf of this user.
3. Call Jira create issue rest api from service defined in step 1
   1. This is straight forward, you can use basic auth with API Key
   2. Create issue in project configured in step 2.1 on behalf of user also configured in step 2.3.
4. DONE

I hope this helps.

[Kain]

Yes, thank you, DPK!