Generate API key
In order to create an API Key, you must first sign up for the Asleep Dashboard.
Dashboard URL
API Key Exposure NoticeAPI Key is the license key required to use the Asleep Service.Please note that the API key used in the development does not leak outside.
Generate API Key
- Sign in with your account after you complete your sign up.
Log in Page
- Click the Profile icon in the upper right corner of the dashboard, and then click Settings.
Profile Icon - Settings
- In API Key Tab, Click Generate API Key button.
Before Generate API Key Step
- API Key is Generated.
Test API Key, Live API Key is generated each
Test API Key & Live API Key Difference
Difference
- Test API Key: The API Key used by the development environment.
- Live API Key: The API Key used by the commercialized product environment.
Characteristics
- If you want to check only the actual user data separately, we recommend using Test API Key and Live API Key separately for your purpose.
- All data is divided and managed by each environment
- You can create up to 3 API keys for each setting, a total of 6 API keys.
- You can check API usage, DAU, etc.by API Key.
- In both the Test and Live environments, independently, user information and session data are retained even if the API Key changes.
- In the [Trial Plan], you must use the Test API Key.
- Under the [Enterprise Plan], valid API calls made using both the Live API Key and the Test API Key are subject to charges.
Revoking an API Key (Revoke)
An API Key that is no longer in use or is suspected of having been exposed should be revoked immediately for safety.
Revocation cannot be undone
- As soon as a key is revoked, all API requests using that key are blocked with a 401 Unauthorized error.
- Once a key is revoked, it can never be reactivated or restored under any circumstances.
Tip: Want to avoid service interruption? If you need to replace the API Key of a live service, we recommend generating a new key first via [Generate], applying it to your system, and then revoking the old key.
How to Revoke
- In the API Key block of Settings, click the [Revoke] button of the key you want to revoke among the keys shown in the [Current] tab.
- When the confirmation dialog appears, review the warnings and click the [Revoke] button.
- The revoked key immediately becomes unusable, and you can check its creation date and revocation date in the [History] tab.
New key generation limit
A revoked key is immediately excluded from the per-environment limit (up to 3 keys), so you can generate a new key in the same environment right away if needed.
Updated 18 days ago