HaloPSA

HaloPSA Guides

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

Guides > Creating a New Application for API Connections

Creating a New Application for API Connections

In this guide we will cover:

- API Details

- Application Configuration



Related Guides:


This guide outlines the configuration of Halo applications which can be used to connect applications to your instance of Halo via the API.


API Details

Navigate to Configuration > Integrations > Halo API to see the related configuration page. This area provides details about connecting to your instance of Halo via the API including resource and authorization servers as well as a link to our official API documentation.


Fig 1. API details.


Documentation about your Halo API can also be found at <Halo Web App Agent Portal URL>/api/swagger.


You are also able to connect to other instances of Halo utilizing the "Connected Instances" area.


Application Configuration

From this page, click "View Applications" to find your list of Halo applications. Note that there are previously configured applications which are used to connect various aspects of your Halo Web App. Please do not adjust any of these existing applications as they are vital in the basic function of your instance of Halo.


Fig 2. List of applications.


To start a new application, click "New" on the top right corner of the screen. 


From here on the "Details" tab, you will be prompted to name your application, enable it, and set its "Authentication Method".


Fig 3. Configuring the application.


For example, we can set our application to "Client ID and Secret (Services)" and we are provided a "Client ID" and "Client Secret" which we can utilize in another application to connect to your instance of Halo. We are also prompted to select a "Login Type" and setting specific to that login type.


On the "Permissions" tab you are able to set exactly what services utilizing this application are able to do in Halo.



Fig 4. Permission options.



Popular Guides