As a PeopleHR administrator, you can create an API key within the system and specify which areas or functions this has access to. API keys are commonly used with our external tools and plugins and for integrating with other systems.
When creating an API key, we've split different areas and functions within the API setup, such as Employee being separate from Timesheets and having specific endpoints, so you can set exactly what access this API key has.
This can also be restricted to only be used from a specific IP address. If providing an API key to your developer or a third party for custom integration, you can specify exactly what areas they can access.
When creating API keys to use for integrating with other tools, you may need to select some specific endpoints.
Example: Selecting all Employee endpoints can be done by using the select all option when creating the API key.
Example: If integrating Timesheets with another system, only select the Timesheet endpoints within the API key so only these areas can be accessed.