Obtaining HaloPSA API credentials

Introduction

This article describes how to obtain HaloPSA API credentials required for integration setup. The integration uses the HaloPSA API to set up and synchronize integration data, including accounts, recurring items, recurring invoices, offering item quota, usage, and overage.

To learn more about the HaloPSA Integration, see this article: HaloPSA Integration

In this article:

• Obtaining HaloPSA API credentials
• Configuring agent permissions

Obtaining HaloPSA API credentials process

To obtain the necessary API credentials from your HaloPSA instance, follow these steps:

1. Log in to your HaloPSA instance.
2. Navigate to Configuration > Integrations > HaloPSA API.
   
3. Note down the values of Resource Server, Authorization Server, and Tenant.
   
4. In the Applications section, click View Applications.
5. Click New.
   
6. Enter an Application Name. We recommend using "Client Portal" as the name.
   
7. Make sure that the Active checkbox is selected.
   
8. Select Client ID and Secret (Services) as the Authorization Method.
   
9. Check Allow Agent Logins in the Login Type checkbox list.
   
   
   
   Warning! Select and Agent Logins first, as it will change your Client Secret.
10. Select a system admin within your HaloPSA instance from the Agent to log in as dropdown list.
11. Navigate to the Permissions tab at the top.
12. Select all of these permissions:
    • read:tickets
    • edit:tickets
    • read:customers
    • edit:customers
    • read:items
    • edit:items
    • read:invoices
    • edit:invoices
13. Note down the Client ID and Client Secret keys.
    
    Warning! The Client Secret will not be visible after this step.
14. Click Save.

Configuring agent permissions

When setting up the HaloPSA integration, ensure that the Agent you plan to assign to the Application has sufficient permissions. Otherwise, the integration will fail to read or update data in HaloPSA.

To verify and configure the Agent's permissions:

1. In your HaloPSA instance, navigate to Configuration > Teams & Agents > Agents.
   
2. Open the agent account that you intend to assign to the application (e.g., "P4 Test Api Agent").
3. Navigate to the Permissions tab.
   
4. Under the Feature Access section, confirm or set the following access levels:
   

Required Agent permissions:

These permissions are required so the integration can:

• Customers — Read, Modify and Delete: retrieve customer/account details from HaloPSA, and create or update customer records when syncing.
• Software Licencing — Read and Modify: read existing subscription records, and create or update subscription details during synchronization.
  
  
  Warning!If the assigned agent does not have these permissions, the integration will not be able to read or update data in HaloPSA, and the synchronization will fail.

Summary

This article guides you through obtaining HaloPSA API credentials by creating a new application in your HaloPSA instance, configuring the appropriate authorization method and permissions, and securely noting the Client ID and Client Secret for integration purposes. Remember that the Client Secret is only visible once during the setup process.

Related content

• HaloPSA Integration
• HaloPSA guides