An API key (Application Programming Interface key) is essentially a unique identifier used to authenticate and authorise other applications when it tries to access an API. Think of it like a password or a digital ID badge for your application to communicate with another service.
Example: You're using the Logiqc API to link a customer feedback form on your website with Logiqc. The engineer developing the form on your website will need an API key to set up the connection with your Logiqc platform.
Steps to create an API key
This should be done by the engineer creating the API key. If this is a third party, you will need to create an account for them so they can create the API key.
-
Assign the permission Admin/Edit API keys to the user needing to generate an API key or if this is a third party provider, create an External user account - Create an external user account so they can can log in and follow these instructions.
-
Go to Admin mode/API Keys (you will need the relevant permissions)
- Click Add key
- Give the key a name and set Expiry to never. Enter the IP address related to the server/s that will will be making the API call. You can use the following formats: comma-separated IPs, ranges, or CIDR blocks.
- If the Key is for SSO configuration, you will enter the Entra IP address 40.126.0.0/18,20.190.128.0/18 eg:
- Click Copy to obtain the key.