<style>p { margin: 0; }span.fr-emoticon.fr-emoticon-img { background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle; } span.fr-emoticon { font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0; } blockquote { border-left: solid 2px #5e35b1; color: #5e35b1; margin-left:0; padding-left:5px;}blockquote blockquote{ border-color: #00bcd4; color: #00bcd4;}blockquote blockquote blockquote{ border-color: #43a047; color: #43a047;} table.grid{ border-collapse: collapse;} table.grid td, table.grid th { border: 1px solid #ddd;} .fr-fic.fr-dib{ display: block; margin: 5px auto;}.fr-fic.fr-dib.fr-fir{ text-align: right; margin: 5px 0 5px auto;}.fr-fic.fr-dib.fr-fil{ text-align: left; margin: 5px auto 5px 0;}.fr-fic.fr-dii{ float: none; margin: 5px auto;}.fr-fic.fr-dii.fr-fil{ float: left; margin: 5px auto;}.fr-fic.fr-dii.fr-fir{ float: right; margin: 5px auto;}img.fr-dib.fr-fir { margin-right: 0; text-align: right;}img.fr-dib.fr-fil { margin-left: 0; text-align: left;}img.fr-dib { margin: 5px auto; display: block; float: none;}img.fr-bordered { box-sizing: content-box; border: solid 5px #CCC;}img.fr-shadow { box-shadow: 10px 10px 5px 0px #cccccc;}img.fr-rounded { border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;}</style><style>
p {
margin: 0;
}
span.fr-emoticon.fr-emoticon-img {
background-repeat: no-repeat !important; font-size: inherit; height: 1em; width: 1em; min-height: 20px; min-width: 20px; display: inline-block; margin: -0.1em 0.1em 0.1em; line-height: 1; vertical-align: middle;
}
span.fr-emoticon {
font-weight: normal; font-family: "Apple Color Emoji", "Segoe UI Emoji", "NotoColorEmoji", "Segoe UI Symbol", "Android Emoji", "EmojiSymbols"; display: inline; line-height: 0;
}
blockquote {
border-left: solid 2px #5e35b1; color: #5e35b1; margin-left: 0; padding-left: 5px;
}
blockquote blockquote {
border-color: #00bcd4; color: #00bcd4;
}
blockquote blockquote blockquote {
border-color: #43a047; color: #43a047;
}
table.grid {
border-collapse: collapse;
}
table.grid td,
table.grid th {
border: 1px solid #ddd;
}
.fr-fic.fr-dib {
display: block; margin: 5px auto;
}
.fr-fic.fr-dib.fr-fir {
text-align: right; margin: 5px 0 5px auto;
}
.fr-fic.fr-dib.fr-fil {
text-align: left; margin: 5px auto 5px 0;
}
.fr-fic.fr-dii {
float: none; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fil {
float: left; margin: 5px auto;
}
.fr-fic.fr-dii.fr-fir {
float: right; margin: 5px auto;
}
img.fr-dib.fr-fir {
margin-right: 0; text-align: right;
}
img.fr-dib.fr-fil {
margin-left: 0; text-align: left;
}
img.fr-dib {
margin: 5px auto; display: block; float: none;
}
img.fr-bordered {
box-sizing: content-box; border: solid 5px #CCC;
}
img.fr-shadow {
box-shadow: 10px 10px 5px 0px #cccccc;
}
img.fr-rounded {
border-radius: 10px; -moz-border-radius: 10px; -webkit-border-radius: 10px; -moz-background-clip: padding; -webkit-background-clip: padding-box; background-clip: padding-box;
}
</style><p><strong>In this guide we will cover:</strong></p><p><strong>- Navigating to the API Configuration</strong></p><p><strong>- Creating an Application</strong></p><p><strong>- Examples</strong></p><p><br></p><p><br></p><p><strong id="isPasted"><span style="font-size: 14pt;">Navigating to the API Configuration</span></strong></p><p>Go to Configuration > Integrations > Halo API. Here you will see the Resource Server URL, Authorisation Server URL, and your Tenant name (if applicable).</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRjZDg3YzdmLWE5OTgtNGE2ZC1iNzExLTRiZjBiNmYyOGU3ZCJ9.VJw8NG3A67eK2jndiTQiasfBnm_PiJRicPyunU5bRxo" class="fr-fic fr-fil fr-dib" width="1152" height="817"></p><p><strong><span style="font-size: 10pt;">Fig 1. API configuration.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Creating an Application</span></strong></p><p>You need to create an API Application containing a set of permissions and credentials, as well as some other configuration options.</p><p><br></p><p>The most commonly used Authentication method is "Client ID and Secret", but you do need to select an Agent to impersonate. The Agent selected here will also be used for permissions which are further restricted by selecting permissions on the Permissions.</p><p><br></p><p>A static API Key can be used as an authentication method. This should only be used if the system you are integrating with does not offer one of the other OAuth flows.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijc0NDZhODE2LTcyNWItNGM2MS05ZmYyLWJjYmY4ZjViNTIyMCJ9.0AvZ8wrrEr3LRT5AEXH3upzYpJDlLr_nTOLbUXykOUU" class="fr-fic fr-fil fr-dib" width="1220" style="width: 1222px; height: 627.831px;" height="628"></p><p><strong><span style="font-size: 10pt;">Fig 2. Creating an application.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Examples</span></strong></p><p>Once this step is complete and saved you can also download examples that can be opened in Postman to help get started.</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjRhMWJmNGM5LTZkMTUtNGJhZC1hNTg2LTI4ZjJkMDFhOGQ4YyJ9._MHxFgtNVsHLyETEs9T5MilB-ZppfnpPvFdQ6jAUZ3c" width="2" class="fr-fic fr-dii"></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjExZTUzMmRiLWI3MzktNDlhYi04ZDhiLWM0ZDU2ZTQwMTRhMSJ9.wI-4imEtkK_FmC9JmkibysTLaz7Ndrog_jar6gH7xn0" class="fr-fic fr-fil fr-dib" width="477" height="99"></p><p><strong><span style="font-size: 10pt;">Fig 3. Download Examples button.</span></strong></p>
