HaloPSA

HaloPSA Guides

Documentation to assist with the setup and configuration of the HaloPSA platform

Guides > How to start using the Halo API

How to start using the Halo API

In this guide we will cover:

- Navigating to the API Configuration

- Creating an Application

- Examples



Navigating to the API Configuration

Go to Configuration > Integrations > Halo API. Here you will see the Resource Server URL and the Authorisation Server URL as well as your tenant name (if applicable).


Fig 1. API configuration.


Creating an Application

To start using the API you need to first create an API Application which contains a set of permissions and credentials as well as some other configuration options.


The most commonly used Authentication method is Client ID and Secret but you do also 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.


Fig 2. Creating an application.


Examples

Once this step is complete and saved you can also download examples that can be opened in Postman to help get started.

Fig 3. Download Examples button.

Popular Guides