Connecting to SageHR

SageHR uses token authentication to control access to the API.

Using Token Authentication

In order to authenticate to SageHR, you'll need to provide your APIKey. To obtain the APIKey follow the steps below:

• Click on your name on the top right, then click Settings.
• On the settings menu, click INTEGRATIONS, then click API.
• Click ENABLE API ACCESS to activate access to API and provide you with your unique API key.

Additionally, you will need to set the Subdomain, found in the URL of your Sage HR account. For example if your Sage HR account is acmeinc.sage.hr, then the Subdomain should be 'acmeinc'. Set both the APIKey and Subdomain in the ProfileSettings property to connect.

Example connection string

Profile=C:\profiles\SageHR.apip;ProfileSettings='APIKey=your_api_key;Subdomain=your_subdomain';

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your Sage HR API Key.
Subdomain	Your Sage HR subdomain.