This article explains how to generate an API key in Folks.
If you do not have access to the API key management page, please ask our team to activate it. Only a company administrator can generate API keys.
|
When generating an API key, it will be marked V2. This is the new version of the API key, useful for employee modules and their personalized fields, time management and organizational structures (see Folks API Documentation V2). By default, the API key management page contains a V1 key. This key is used to access timesheet files and the ATS (see Folks API Documentation V1). This key can be updated as required from the company page. |
- In Folks, navigate to the API key management page (Admin > Company > API Key Management).
- In the top right-hand corner of the page, click Generate new API key.
- In the window that opens, give your API key a name and specify an expiration date, if desired.
- Under the Parameters section, you can activate the options for granting access to sensitive information (SIN, salary and banking information) and to employees' personal information.
- Under the Content of the API key section, you can select the desired access levels for employees, custom fields, absences, overtime, vacation, balances, positions, departments, working sites and admin (corresponds to all positions, departments and working sites).
- Click Generate. A message containing the unique identifier and the API key (secret key) will appear.
Warning! The key will only be displayed once. Copy it in a safe place so as not to lose it, then close the window.
You can edit the parameters of a V2 API key by clicking the ellipsisand selecting Edit. When you save your changes, all access tokens associated with the key will become invalid.
To delete a V2 API key, simply click the ellipsisand select Delete.