The Zimark REST API uses an API key authentication via the X-AUTH-KEY header.
To access the Zimark API, you must first create and securely store an API key. This guide explains how to generate a key, configure restrictions.
- ✅ Access to the Zimark Backoffice.
- ✅ Appropriate permissions to manage API keys within your organization.
- Navigate to Administration → API Keys
- Click Add key
- Configure the key:
- Enter a descriptive name and purpose
- (Optional) Add IP restrictions Note: After creation, only IP restrictions can be modified.
- Click Create
- Copy the key - it will not be shown again
Security: Store the key securely. After creation, only IP restrictions can be modified.
Include the API key in every request:
- Header name:
X-AUTH-KEY - Value format:
ZIM.***************