HaloPSA

HaloPSA Guides

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

Guides > Setting up an API Agent

Setting up an API Agent

Setup

When setting up an API Agent (or any agent that is going to use the API) to use with an API Application it is important to understand the permissions that the API Application is given.


The permissions are a cross between the API Application as well as the  Agent that is nominated to run the API.

In this case "Tim Bowers" is set to be impersonated for the API Application and the API Application has "Read:Tickets" as below.

So the API Application would have all of the permissions that are configured for the agent "Tim Bowers" but only for "Read:Tickets"


This means that if the Agent only had access to one Customer then the API Application would only be able to read Ticket data from that one Customer.


Common Use Cases

The most common use case is to setup an API Application that can read and update/create Tickets.


This means that the Agent nominated to run the API Application will need to be part of a Team or Department that can access the relavent tickets as well as the following specific permissions.


If there is no data returned it is a good idea to log into Halo as that Agent and check that there are Tickets visible. If they are not then the permissions are likely incorrect for the Agent.



Popular Guides