Authentication
Every API request requires your group's API key in the Authorization header.
Getting Your API Key
- Log in to the Vivreal portal
- Go to Group Settings from the dashboard
- Open the Settings tab
- Copy your API key
Using Your API Key
Pass it in the Authorization header:
curl "https://client.vivreal.io/tenant/siteDetails?siteId=YOUR_SITE_ID" \
-H "Authorization: YOUR_API_KEY"
Keep it secret
Your API key grants access to your group's content. Always call the API from your server — never expose the key in client-side code.
Key Details
| Scope | Read-only access to your group's published content + checkout + contact email |
| One per group | Each group has a single API key |
| No expiry | Valid until you rotate it in Group Settings |
| Header | Authorization: your-api-key |
Error Responses
| Status | Meaning |
|---|---|
| 401 | Missing or invalid API key |
| 403 | Valid key but account is frozen |