Setting up the HaloPSA API for ITSupportPanel

Modified on Thu, Nov 30, 2023 at 1:10 PM

Setting up the

HaloPSA API for ITSupportPanel

Version Date: 2022.05.05

To complete Step 3 of the Invarosoft Setup Wizard, and to integrate with your HaloPSA installation we need you to configure a login (API) account for use by ITSupportPanel.

The following instructions will assist you in performing this configuration in your Halo PSA environment and identify the information required during the second step of the Invarosoft Setup Wizard.

1. log in to your Halo PSA web interface with an admin-level user account.

2. Navigate to “HaloPSA API” found under “Integrations” which is under the settings gear cog menu.

3. Take note of the following values under “API Details” on the screen that appears

Resource Server
Authorisation Server
Tenant

4. Click on “View Applications” found under the “Applications” heading on the same page as step 3.

5. Click on “New” at the top right of the page

6. Name your application, ensure “active” is ticked and then select “Client ID and Secret (Services)” as the Authentication Method

7. Under Login Type select “Agent” and select an agent name under “Agent to log in as” (see note below)

8. Take note of the “Client ID” & “Client Secret” found between the two sections pictured in step 6 & 7 above.

9. Select the “Permissions” tab at the top of the page

10. Tick the box next to “all”

11. Click on “Save”

NOTE: For the agent selection in step 7, if you do not wish to use an existing agent, please reach out to your HaloPSA account manager for a free API agent licence. If you have any issues with this, please talk to our sales team who can assist.

You have now completed the API setup requirements. The details you will need for the wizard are as follows;

Site This is your HaloPSA domain name.

Client Id This is the Client ID from step 8.

API Key This is the Client Secret from step 8.

NOTE: For “Site” only put the domain name of your HaloPSA instance in site, do not include http/https or any slashes.