<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;}</style><p><strong>In this guide we will cover:</strong></p><p><strong>- Importing Data</strong></p><p><strong>- Authentication</strong></p><p><strong>- Resources and Data</strong></p><p><strong>- Common Issues</strong></p><p><br></p><p><br></p><p>Documentation on the Halo API can be found by going to your Halo URL and adding "/apidoc" to the end, or a full list of endpoints can be found <a href="https://usehalo.com/swagger/" target="_blank" rel="noopener noreferrer"><strong>here</strong></a>.</p><p><br></p><p>We allow the exporting and importing of a lot of your data in JavaScript Object Notation (JSON) format.</p><p><em><br></em></p><p><strong><span style="font-size: 14pt;">Importing Data</span></strong></p><p>To authorise any connection to your Web-App through the API you must register the application, this is done through the integrations tab of the configuration and navigating to the Halo API.</p><p><br></p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY4ZGM3NGEzLWViNGUtNDMxYS1hZjE4LWM3MDgwZTU0NzJlZSJ9.C8V9ixkAenGNsMmenl6GoSqKWuyRS6Giqc7Z7dYHsnc" class="fr-fic fr-dii" width="132" height="133"></p><p><strong><span style="font-size: 10pt;">Fig 1. Integrations module.</span></strong></p><p><br></p><p>Configuration > Integrations > HaloPSA API (or whichever product you use).</p><p><img src="https://halo.haloservicedesk.com/api/attachment/image?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImUxODg3MzNmLTdlY2UtNDgyZS05ZGQwLTY4NTFlNzI1YWQzZSJ9.cQBPf7ebuMXh2b9nDfqnAe7gOhIOnC2yHaoqppt_hFU" class="fr-fic fr-fil fr-dib" width="137" height="124"></p><p><strong><span style="font-size: 10pt;">Fig 2. Halo API module.</span></strong></p><p><br></p><p><strong><span style="font-size: 14pt;">Authentication</span></strong></p><p>This is fully explained in the aforementioned API documentation and will allow your program to have continued access whilst the integration whilst the integration is active in Halo.</p><p><strong><br></strong></p><p><strong><span style="font-size: 14pt;">Resources and Data</span></strong></p><p>By default, the resource server is available at *your Halo Web Application url*"/api". Each resource then has it's own endpoint, e.g. tickets are available at *your Web Application url*"/api/tickets". Endpoints accept the HTTP GET, POST and DELETE methods depending on the resource that you are accessing.</p><p><br></p><p><strong>GET </strong>- will return a dataset depending on the parameters in the Request.</p><p><strong>POST </strong>- will accept an array of objects to add or update. Not all fields are required, only those that need to be updated and the ID field.</p><p><strong>DELETE </strong>- require an ID and will remove the resource with that ID.</p><p><br></p><p>Each resource and method is protected by a minimum authentication level.</p><p><br></p><p><strong>No Authentication </strong>- can access without a token.<br><strong>User </strong>- can access as a Halo end user.<br><strong>Agent </strong>- can access as a Halo agent.<br><strong>Admin </strong>- can only access as a Halo administrator.</p><p><br></p><p>Resources may be protected further by permissions depending on your Halo configuration.</p><p><br></p><p><strong><span style="font-size: 14pt;">Common Issues</span></strong></p><p>Your program will not receive a grant token:</p><p><br></p><ul><li>This can often mean that your program does not have access to a valid or up to date SSL Library. Current ones can be <a href="https://ftpfiles.nethelpdesk.com/openssl.zip">downloaded here.</a> These should be placed in the working directory for the program.</li><li>Somewhere in the input of data a spelling mistake was made.</li></ul>
