What are API Keys? An API Key is a code passed between computer programs - a unique identifier and a secret token used for authentication that allows the two computer programs to communicate. You need an API Key for any Enterprise third party integration who uses this method to pass information between parties.
For example, let's say you wanted to integrate Career Builder with Enterprise. In order for resumes sourced from Career Builder to automatically parse into Enterprise, an API Key is needed. This key gives the green light (e.g. verifies that the software is not malicious) and creates a communication bridge between the two programs allowing information (i.e. resumes) to pass.
How to Add an API Key:
Navigate to (1.) all options → (2.) integrations:
Select "api keys" in the upper left:
Once there, click the + icon to add an API Key. This will open the API Keys window and ask users to define the Description, Level, and Owner.
Description: A way to identify what integration this API Key is for. Ex. Fyre, Career Builder, etc.
Level: Is this integration going to be used (3.) by many people or just one?
- Used by many: Select Hierarchy. This allows users to define where in the hierarchy the key should be used. By one specific branch, entity, or multiple entities.
- Used by one: Select Service Rep. The owner will then be the specific person.
Owner: The company, branch, or person associated with this API Key.
Following our example, based on the information shown below the API Key is for the Fyre integration and belongs to the entity High Tech Staffing:
Upon selecting save, an "api key added" window will appear confirming the key has been successfully added, and the (4.) auto generated key will be listed. (5.) Copy the key to your clipboard if you are ready to pass this information along to the third party.
The third party - Career Builder, Fyre, etc. - will need the (6.) Tenant Name and (7.) API Key in order to successfully configure settings on their end.