Getting an API Key
Open the Dealership Manager
In the Hrizn Dashboard, navigate to the dealership you want to integrate with.
Create a new key
Click Create API Key. Configure:
- Name - A descriptive label (e.g. “DSRPTV Production”)
- Scopes - Which endpoints the key can access
- Rate Limit - Requests per minute (10-500)
- Expiration - Optional expiry date
The raw API key is shown only once at creation time. It cannot be retrieved later — if you lose it, you’ll need to create a new key. Copy it immediately and store it in a secrets manager or environment variable.
Scope Access Model
API keys are granted specific scopes that control which endpoint groups they can access. Each scope maps to a set of related endpoints:Using Your API Key
Include the key in theX-API-Key header:
Key Format
API keys follow the format:hzk_a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890a1b2c3d4e5f67890
The first 12 characters (hzk_a1b2c3d4) are stored as the key prefix and visible in the dashboard for identification.
Key Security
| Feature | Detail |
|---|---|
| Storage | Keys are SHA-256 hashed before storage. Hrizn never stores raw keys. |
| Display | The raw key is returned exactly once at creation time. |
| Revocation | Keys can be revoked instantly from the dashboard. |
| Expiration | Keys can have optional expiry dates (30, 90, 180, 365 days). |
| Isolation | Each key is bound to a single dealership site. |
| Rate Limits | Each key has independent per-minute and per-day rate limits. |
Scope Presets
Use these presets when creating keys, or select individual scopes:- Full Access
- Read Only
- Content Generation
- Inventory Only
All available scopes. Use for trusted, full-featured integrations.
ideaclouds:read ideaclouds:write content:read content:write compliance:write content_tools:write inventory:read inventory:write webhooks:read webhooks:write site:readError Responses
| HTTP Status | Error Code | Meaning |
|---|---|---|
401 | unauthorized | Missing or invalid API key |
401 | key_expired | API key has passed its expiration date |
401 | key_revoked | API key has been explicitly revoked |
403 | forbidden | API key lacks the required scope for this endpoint |