Page tree
Skip to end of metadata
Go to start of metadata

Overview

greytHR provides API's that you can integrate with your business apps to send or receive employee, salary and attendance data. To use the greytHR API's, you need to first generate the API keys. API key is a secret key which must be passed to the greytHR application while calling the API. 

The API feature is available only to SUPER and CRUISER plan users.

To generate the API key for Employee & Salary API:

  1. Navigate to My Account > API Details.
  2. In the API Keys section,click the 
  3. You can either generate API key for the Employee & Salary API or for the Attendance Swipe API. Select the option for generating Employee & Salary API key.
  4. Click Generate API Keys.
  5. The API key is generated and displayed only once. So, make sure that you copy the API key.
  6. Click Done.
    API User refers to the name of the API user and is auto generated. Access ID is a unique ID to identify the customer. API Key is a secret key which must be passed to the API.

    For the Employee and Salary API, you can generate only one API key.

To generate the API key for Attendance Swipe API:

  1. Navigate to My Account > API Details.
  2. In the API Keys section,click the 
  3. You can either generate API key for the Employee & Salary API or for the Attendance Swipe API. Select the option for generating Attendance Swipe API key.
  4. Click Generate API Keys.

  5. Click Done.
    Domain URL refers to the URL that is used by the customer to access the greytHR application. The API Name refers to the unique name associated with the API and is editable. API ID is the unique API key which is displayed only once.
    i. Click Download Private Key to generate the PEM (Privacy Enhanced Mail) which is the certificate or encoded file.

For the Attendance Swipe API, you can generate multiple API keys.

Delete / Regenerate API Key

Once an API key is created, you can either delete it or regenerate it.

  1. Click  to delete the API key.
  2. Click Regenerate to regenerate the API key. The API key is regenerated with all references to the previous key removed.
  3. Click Regenerate to confirm.

Please do not share the following info:

Access ID: Unqiue ID generated for every customer. Will remain the same for both Attendance and Employee APIs.

API Key: Unique key for API Access

API ID: Unique API ID for the Attendance API

API Name: Custom field given to set the name/ identifier for the Attendance API

PEM: Certificate / Encoded file

Domain URL: URL which is the same as your login URL