Tesseract Tools - Documentation  UnityTools
Professional grade GameDev tools
Loading...
Searching...
No Matches
Setting Up Github API

For this setup we'll assume you already have a Github project. First we'll need to setup an API key.

API Key

Click on your profile icon in the top right corner to bring up the account context menu. Go down to 'Settings' and click on that. Once on your settings page click on 'Developer Settings'.

Create a New API Key

Note
THE API Token will be shipped with your game, and so users could be able to access it if they rip apart your binaries/final package. Give some thought to which user will be creating the API/User tokens and how much access they have to your larger Trello and Atlassian products.

We're going to want to create a 'Fine-Grained Personal Access Token' so that we can control the access rights for that specific token. Click on Generate New Token:

This will let you choose a name for this key, a description, expiration as well as which repo's you want to limit this key too.

You will also wan to make sure that your personal access token has access to the 'Issues' permission:

Imgur

Github doesn't support uploading images through their REST API, instead we rely on uploading to Imgur and then we pass the link to the github issue description. With that said, you'll need to have an Imgur account and create an Application to get and API ClientId and Secret.

Note
While the uploads are anonymous and urls are random, the image urls are accessible by the public. If you wish to keep your images and feedback private then disable screenshots. That delete hashes are appended to the tickets so that you can delete them manually afterwards.

The images are uploaded anonymously, i.e. not tied to any account, but tied to your ClientId. The delete hashes are added to each description which can be used to delete the images using your ClientId and a POST request.

Once you have an Imgur account you'll need to go to Imgur's App Registration page here to generate a ClientId and ClientSecret.

Next Steps

Now that we have an API key setup we can Configuring Github with Unity.