API keys allow you to access the compression service programmatically. They provide secure authentication for your applications and scripts.
Creating an API Key
To create a new API key from your dashboard:
- Navigate to your dashboard and click "API Keys" in the sidebar
- In the "Create new API key" section, enter a descriptive name for your key (e.g., "my script key")
- Click the "Create key" button
- Copy the generated key immediately - you won't be able to see it again!
- Store it securely in your application using environment variables
Important: The API key is only shown once when created. Make sure to copy and store it immediately!
Your API Keys Table
The "Your API keys" section shows all your keys in a table with the following information:
- Name: The descriptive name you gave the key
- Created: When the key was created (in YYYY-MM-DD HH:MM:SS format)
- Last Used: When the key was last used for an API call (shows "Never" if unused)
- Status: Shows "Active" (green) or "Revoked" (red)
- Actions: "Revoke" button for active keys
Revoking API Keys
If a key is compromised or no longer needed:
- Navigate to your API Keys page
- Find the key you want to revoke in the table
- Click the "Revoke" button in the Actions column
- Confirm the action when prompted
Warning: Revoked keys cannot be restored. You'll need to create a new key if needed.
Security Best Practices
- Never share your API keys publicly or commit them to version control
- Use environment variables to store keys in your applications
- Create separate keys for different applications or environments
- Regularly review and revoke unused keys
- Monitor key usage in your dashboard
- If you suspect a key is compromised, revoke it immediately
Using Your API Keys
Once you have an API key, you can use it to authenticate API requests. For detailed information about endpoints, request formats, and code examples, check out the API documentation.
Need Help?
If you're having trouble with API keys or need assistance with programmatic access, feel free to contact [email protected].
