HR

Step-by-step guide

This help guide will show you how to configure API's in HR.

Contents

• Introduction
• Configuration
• Filtering
• Delete
  
  

Introduction

An API (application programming interface) is a connection between computers or between computer programs, typically for data exchange. They can be used to share Ciphr data with third party systems (or your own internal systems) to reduce manual administration of data, whilst also enhancing your data security and integrity.

Configuration

You will need to grant Access to the API Configuration for the appropriate user(s) to utilise the page via the following area:

• Latest (left-hand) menu: System Configuration > Role Management
• Pre 2025 (top) menu: System > Security > Role Management

Select the user role > Actions > Pages

The API configuration page enables high level maintenance of your existing Ciphr API configuration, including the keys, entities and properties. The page can be accessed via the following area:

• Latest (left-hand) menu: System Configuration > API Configuration
• Pre 2025 (top) menu: System > Security > API

The maximum number of keys is maintained through a system configuration key which is controlled by Ciphr. If you have capacity to create additional API Keys then you will see an Insert New Record button, otherwise the button will not be present if you have reached your limit.

Clicking the buttons against the associated key will present different options:

Configuration view allows the following:

• Maintain the access of the key, entities and properties
• Re-generation of the API Key
• Note: When re-generated, a once only copy to clipboard is available
• Maintain the allow list of IP addresses
• Maintain the expiry date. Keep this as a future date to ensure the key is active

• The overall key Access controls the entities below. Eg if you wish to ensure no entities are removed by accident, disabling the Delete Access will then apply to all entities and properties within
• A message will alert you to confirm this before applying the change

• If you decide to change the Access permission in the future, enabling the Key Access will not apply to all, but you can then enable the relevant entities as required
• When you click to enable an entity, a replicate button will appear if you wish to apply to all entities below

• Click Update at the bottom of the page to save any changes made
• Clicking the arrow next to an entity will expand it to see the properties within. The access is managed in the same way as the key and entity
• Click Add to see a list of available properties to add
• Click Update at the bottom of the page to save any changes made
  
  

Filtering

This view allows:

• Maintenance of future starters and past leavers. Select ‘All’ or up to 12 months
• Maintenance of the people filtering (Record Groups or Payroll Codes)
• Maintenance of the absence code filtering if the Absence entity has been added to the configuration

Available Record Groups, Payroll Codes and Absence Codes can be added and deleted using the associated buttons

Click Update at the bottom of the page to save any changes made

A shortcut button allows you to switch between configuration/filter options within the key.

If you have made changes and click this button before clicking Update to save, a warning message will appear. Click No if you wish to save changes before continuing.

Delete

This button will remove the API and all associated configuration and is irreversible.

A warning message will appear to confirm you wish to delete the Key.