How to Generate API Key

This article provides step-by-step instructions on generating API Keys in Yomly, which can be used to integrate data with other applications such as your local biometric system, calendar, or payroll software.

Requirement: HR Admin access level

Steps:

1. From the Dashboard, click on Settings.

   
   

    

2. In the Settings window, under the General tab, select API Keys.
   
   
   
   

3. Go to the API Keys tab and click + Add API Key.
   
   
   
   

4. In the new window, fill in the following details:

   Required fields:

   • • Issue Date – The start date of the API Key’s validity.
     • Valid For (date) – The end date of the API Key’s validity.

   Optional fields:

   • • ipCDR – The IP address/subnet for which the API Key will be valid (this is usually left blank).
     • Comments – A note to identify the purpose of the API Key (e.g., “Calendar Integration”, “Biometrics Integration”). This helps easily locate the key later.

   
   
   
   

5. Click Generate API Key. The newly generated key will be displayed.

6. Copy and save the API Key securely for later use, then click Close.
   
   
   
   

7. Once closed, locate and copy the API Key ID. This will also be required for integrations.