API Key Management
API Keys are used to securely authenticate and authorize external applications, devices, or services when connecting to the platform.
What Can You Do Here?
Using the API Key Management page, you can:
- Generate new API Keys
- View existing API Keys
- Enable or disable API access
- Copy API Keys for integration
- Update API Key details
- Delete unused API Keys
- Search for specific API Keys
Generate an API Key
To create a new API Key:
- Click Generate API Key.
- Enter the required details.
- Click Save.
The system will generate a unique API Key that can be used to connect external applications or services.
Create separate API Keys for different applications to simplify access management and tracking.
View API Keys
All generated API Keys are displayed as individual cards showing:
- API Key Name
- Generated API Key
- Current Status
- Available Actions
This provides a quick overview of all active integrations.
Enable or Disable an API Key
Use the status switch available on each API Key card.
Active
The API Key can be used to access the system.
Inactive
The API Key is temporarily disabled and cannot be used for authentication.
Disabling an API Key immediately blocks access for applications using that key.
Copy an API Key
To copy an API Key:
- Click the Copy icon.
- The key is copied to your clipboard.
- Paste it into the required application or integration.
Update API Key Information
To modify API Key details:
- Click the Edit icon.
- Update the required information.
- Click Save.
The changes are applied immediately.
Regenerate an API Key
If an API Key is compromised or needs to be replaced:
- Click the Regenerate option.
- A new API Key will be generated.
After regeneration, applications using the previous key must be updated with the newly generated API Key.
Delete an API Key
To permanently remove an API Key:
- Click the Delete icon.
- Confirm the deletion.
The API Key will no longer be available for authentication.
Deleting an API Key immediately stops all integrations using that key.
Search API Keys
Use the search box to quickly locate API Keys by:
- API Key Name
- API Key Value
Search results are filtered automatically as you type.
Best Practices
✅ Create separate API Keys for different applications.
✅ Disable unused API Keys instead of keeping them active.
✅ Regenerate API Keys periodically for improved security.
✅ Share API Keys only with authorized users and systems.
❌ Do not expose API Keys in public repositories or unsecured documents.
❌ Do not reuse the same API Key across multiple environments whenever possible.
Example Use Cases
| Scenario | Purpose |
|---|---|
| MES Integration | Connect manufacturing systems |
| IoT Devices | Send machine data to the platform |
| Third-Party Applications | Secure API access |
| Analytics Tools | Retrieve operational data |
| Mobile Applications | Authenticate application requests |
Proper API Key management helps maintain secure and controlled access to platform services.