Guided implementation
From the boundary to a verifiable result.
- 01
Define the project boundary
Create one app per product and environment in the workspace. Request only the operations the server genuinely needs.
- 02
Store the key once
The complete key is shown only immediately after issue. Put it in your server-side secret store.
export CLARITY_API_KEY='clt_test_…' - 03
Make the status check observable
The status endpoint confirms the project, environment, scopes and API version without opening private Clarity data.
curl https://clarity.audecius.com/api/developer/v1/status \ -H "Authorization: Bearer $CLARITY_API_KEY" \ -H "X-Request-ID: academy-quickstart-01" - 04
Plan rotation
Issue the new key first, update your server and then revoke the old one. Keys expire after no more than 180 days.
Complete when …
- The key exists only on the server
- The response contains the request ID
- Unneeded scopes have not been granted
- The revocation path has been tested
