Sage HR
Sage HR is a cloud-based human resources management platform that helps organizations manage employees, teams, leave, documents, and onboarding and offboarding workflows. Its REST API exposes HR data such as employees, teams, leave requests, and leave-management policies. Nexla connects to the Sage HR API to ingest this data for reporting, analytics, and downstream integration.
Power end-to-end data operations for your Sage HR API with Nexla. Our bi-directional Sage HR connector is purpose-built for Sage HR, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Sage HR or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Sage HR workflows fast, secure, and fully governed.
Features
Type: API
- Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
- Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
- API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
- Request optimization with intelligent batching, retry, and caching to minimize API calls and costs
Prerequisites
Before creating a Sage HR credential, you need an API key and your Sage HR API base URL. Sage HR uses API key authentication, with the key sent in the X-Auth-Token header on every request. Generating an API key requires admin permissions in Sage HR.
To obtain your Sage HR credentials, follow these steps:
-
Sign in to Sage HR with an account that has admin permissions.
-
Select your name in the top-right corner, then select Settings.
-
Select Integrations, then API.
-
Select Enable API access. Sage HR generates a unique API key for your user.
-
Copy the API key and store it securely, as it will be used to authenticate your Nexla credential.
-
Determine your API base URL. Sage HR API requests are made against your company's own subdomain, following the pattern
https://{'{subdomain}'}.sage.hr/api, where{subdomain}is your organization's Sage HR subdomain.
Keep your API key confidential and do not share it with third parties. If an admin loses admin permissions, Sage HR invalidates their API key. For more information, see the Sage HR API documentation.
Authenticate
Credentials required
| Field | Required | Secret | Description |
|---|---|---|---|
| API Key | Yes | Yes | API key. |
| Base URL | Yes | No | API base URL. |
Create a credential in Nexla
-
After selecting the data source type, click the Add Credential tile to open the Add New Credential overlay.
-
Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.
-
Enter your Sage HR API key in the API Key field. This is the key you generated in Prerequisites, and it is sent in the
X-Auth-Tokenheader for all API requests to Sage HR. -
Enter your API base URL in the Base URL field. This is your company-specific Sage HR API endpoint, following the pattern
https://{'{subdomain}'}.sage.hr/api.Keep your API key confidential. If it is compromised, disable and regenerate API access from Settings > Integrations > API in Sage HR.
For detailed information about Sage HR API authentication and available endpoints, see the Sage HR API documentation.
-
Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source creation.
Use as a data source
To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Sage HR connector tile, then select the credential that will be used to connect to Sage HR, and click Next; or, create a new Sage HR credential for use in this flow.
Endpoint templates
Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Sage HR endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.
Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.
Manual configuration
Sage HR data sources can also be manually configured to ingest data from any valid Sage HR API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.
Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Sage HR data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.