📱 App Centre: Integration → Manage API Key
Overview
The Manage API Key page controls the API key used to authorise communication between the app and your server.
The API key acts as a secure credential that allows the app to send approved requests to the server and receive data in return.
Without a valid API key, app communication features may not work correctly.
What this page does
From this page, you can:
- create an API key
- view the current API key
- copy the key
- enable or disable the key
- delete the key
How to use Manage API Key
1. Create the API key
If no key currently exists, you will see a Create API Key button.
Clicking this will generate a new secure API key for the app integration system.
2. View and copy the key
Once created, the key will appear in the table.
The key can be copied for use in app configuration where required.
Because the API key is used for authorisation, it should be treated as sensitive information.
3. Check the created date
The Created At column shows when the key was generated.
This is useful for internal reference if a key has ever been rotated or replaced.
4. Enable or disable the key
The Status column shows whether the key is active or inactive.
- Active means the key can be used for app communication
- Inactive means the key is disabled
A button is provided to toggle the key status.
5. Delete the key
A delete option is also available.
This should only be used if you are intentionally replacing the key or retiring the integration setup.
Deleting a key may stop your app from communicating with the server until a new one is configured.
Best practice
- Treat API keys as secure credentials
- Do not share them unnecessarily
- Do not delete or disable a key unless you understand the effect on the app
- If a key is replaced, the connected app configuration must normally be updated as well
Important note
In most cases, the API key is created and managed by Hoofpick/Apparati as part of the technical app setup.