<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>- Setting up an API Agent</strong></p><p><strong>- Use of an API Agent</strong></p><p><br></p><p><br></p><p>API agent accounts do not take up licences, are free of charge and are used for accessing the Halo Integrator and API connections. </p><p><br></p><p><strong><span style="font-size: 14pt;">Setting up an API Agent</span></strong></p><p>To set up an API agent account, go to Configuration > Agents > New.</p><p><br></p><p>Give it a sensible, identifiable username and ensure your settings match the below image.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImYwMjE0M2IxLWFmYWMtNDVhMC1hOTEzLTY4YTRmMjFkNjc2ZCJ9.kXnXUaSaUgo4oBNRr1LS49a8HcCMgtvxOYeUDdYW34Q" class="fr-fic fr-fil fr-dib" width="899" style="width: 899px; height: 545.547px;" height="545.547"></p><p><strong><span style="font-size: 10pt;">Fig 1. API agent settings.</span></strong></p><p><br></p><p>Once ready, save.</p><p><br></p><p><strong><span style="font-size: 14pt;">Use of an API Agent</span></strong></p><p>Now, you can use this account to log in as for the Halo Integrator and other API applications.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVhNDYwOGQ1LWMyNTYtNDFjYS1iNjk4LTM4ZDk0ZGFjOWI1NCJ9.kQynB3Zzpe1pDYS3By-1yvhw8bwyZHtPwcYI_7eStg0" class="fr-fic fr-fil fr-dib" width="735" style="width: 735px; height: 227.182px;" height="227.182"></p><p><strong><span style="font-size: 10pt;">Fig 2. Using an API agent.</span></strong></p><p><br></p><p><span style="color: rgb(226, 80, 65);"><strong>If you are switching from a standard agent account on the Halo Integrator/API application, please ensure that you re-generate the client secret upon changing the agent to log in as otherwise this will cause the applications to fail.</strong></span></p><p><span style="color: rgb(226, 80, 65);"><strong><br></strong></span></p><p><span style="color: rgb(226, 80, 65);"><strong>If your Halo integrator is hosted with us, please let us know of the change and we can update this for you. </strong></span></p><p><br></p>
