API Keys
A Wildeye API key is a unique identifier used to authenticate and authorize requests to the Wildeye REST API. It acts as a secure token that allows your application to interact with Wildeye's data and services. To access the Wildeye API, you include your API key in the request headers (as a Authorization: Bearer <API_KEY> header). This key ensures that only authorized users or systems can access Wildeye's resources, enables usage tracking, and helps maintain security. It is crucial to keep your Wildeye API key private and avoid exposing it in client-side code or public repositories.
To setup and configure an API Key, access the Wildeye API tab on the settings page.
API Key list page
Creating a new key
New keys should be create for each individual third party/use case/software system that will call the API. This allows securing the access of the key to only the sites or clients it should have access to.
Name | Set the name of the API key to something that will identify the use case and access the key has. This will make it easier to manage the key and delete the right key in the future when it is no longer required. |
Client | A key can belong to a specific client. By default this will set access permissions for the key to all of the sites belonging to this client. If you need more fine grained permissions on a key, please contact the support team. |
Add key screen
After clicking the Generate API Key button, an API key will be shown in the Key field on the right. Copy the key by selecting all the text.
Below is a sample API key:
eyJhbGciOxxxxxxxxxxxxxxI6IkpXVCJ9.eyJpZxxxxxxxxxxxxxxxxxxxxxX0.0eM6wvpxxxxxxxxxxxxxx-NwWGnj_cEzrY
Removing a key
If a key has been compromised and an un-authorized party has gained access to a key, you can delete it. This will block that key from getting access to any data.
It’s a good idea to use one key for development and testing, then remove this and create a new key for production.
To delete a key, click the X at the end of the row.
A prompt will appear to confirm deleting the key.
Delete key confirmation screen
Securing / scoping a key
At present a Key can only be scoped to a client in the website. However the Wildeye team can adjust the access a key has so it can be granted access to:
A set of clients
A set of groups
A set of sites
Please contact the support team to have the access of an API key adjusted.