intelliHR provides a Public API that can be used to connect your intelliHR platform with other software used in your organisation such as payroll, ATS or LMS platforms. The Public API Access Keys page within settings allows administrators, and others granted access such as developers, the ability to create access keys that will allow access to the intelliHR public API.
What is the Public API?
The intelliHR public API (application programming interface) allows you to connect your intelliHR platform with other software that may be used in your organisation. Using the public API, your IT team will be able to create data flows between intelliHR and other platforms; for example, log completed training on intelliHR when it is completed within your LMS or create a new person on intelliHR when they are successfully hired within your recruitment software.
Public API Access Keys
On the Public API Access Keys page within Settings, administrators and those with the correct permissions can create an access key (similar to a token) that provides access to the intelliHR public API.
To generate an access key:
- Using the main menu on your left, go to Settings
- Under the settings menu, go to Public API Access Keys
- Click Create Access Key button
- When prompted, enter a name for the Access Key
- Copy the generated Access Key somewhere safe
Granting Access to the Public API Keys page in Settings
As a system administrator, you may wish to provide a member of your IT team with access to this area of the system in order for them to make use of the public API and begin building connections between intelliHR and the rest of your tech ecosystem.
To provide access the user must be assigned a permission group that includes the permissions below: