Sage HR
Sage HR is a cloud-based human resources management solution that helps you to remotely track, manage and engage your employees in a single platform. It also allows you to integrate workforce management and provide an amazing tool to enhance human resource operations by automating the repetitive process.
Authorization
OAuth 2.0
OAuth 2.0 allows Sage HR users to authorize your app to access their data without sharing their actual login details.
With every API request, you must supply a valid Access Token within the Authorization header:
Authorization: Bearer ‹‹Access Token››An Access Token belongs to a single user account in HR. This means that a user can access all the data of their related businesses (a user might have access to one or more businesses associated with their lead business).
When using the HR API with an API client, you can select the business you want to read or amend data by providing the example-Business header in each request that specifies the Business ID. The example-Business header is optional – if not set, the API will return data of the user’s lead business.
To connect to Sage HR, you will first need to create and configure a Connected App within Sage Accounting. Be sure to enter Sapper's OAuth callback URL -Sapper - as a Callback URL. Select require secret for webserver flow and require secret for refresh token flow:
Once the app has been created, you will be provided with a Client Id and Client Secret.
Create a new connection for the Sage component and use the following values:
For Client ID and Client Secret enter the values that you received previously.
For Scopes enter either
full_accessorread-only. Sage Authentication Documentation
Input | Description | Examples |
|---|---|---|
Authorize URL | The OAuth 2.0 Authorization URL for Sage | |
Client ID | Client Identifier of your app for Sage | xxxx |
Client Secret | Client Secret of your app for Sage | xxxx |
Scopes | Space separated OAuth 2.0 permission scopes for Sage | full_access |
Token URL | The OAuth 2.0 Token URL for Sage |
Sage HR Connection
Sage HR OAuth2.0 Connection
Input | Key | Description | Example |
Select application | application | Select Sage HR application |
|
Connection type | connection type | Select the type of connection. | REST |
REST connection type | rest connection type | Select the type of REST connection. | OAuth2.0 |
Connection name | name | Provide a name for the connection. | Sage HR connection |
Connection description | description | Provide a description for the connection. |
|
Host name | host | Provide a string value for the URL of user's Sage HR account. |
|
Grant type | grant type | Provide the grant type - Authorization code, Password, Client Credentials. |
|
Actions
Get Employees
Get employees | key: getEmployees
Get Positions
Get employees | key: getPositions
