This guide explains how to retrieve your API key from the dashboard. The API key is essential for authenticating and using the API.
Step-by-Step Instructions
1. Log In to the Dashboard
- Navigate to the Dashboard Login Page.
- Enter your credentials (email and password) and click Log In.
2. Access the Account Section
- Once logged in, click on My Account button located on the top-right corner or go direct to My Account URL
3. Create or View Your API Key
A first API Key is generated automatically.
-
To view your API Key, click on [Button]
-
To copy your API Key, click on [Button]
-
To regenerate a new API Key (Discarding the previous one), click on the Regenerate API Key button
4. Security Recommendations
- Keep Your API Key Secret: Never share your API key publicly or expose it in client-side code (e.g., JavaScript in a browser).
- Regenerate a Key if Compromised: If you believe your API key has been compromised, return to the dashboard and use the Regenerate Key option.
5. API Authentication
To authenticate with the API, include your API key in the request headers as follows:
X-GenaSQL-Key: <your-api-key>Troubleshooting
If you encounter any issues while retrieving your API key, consider the following:
- Access Denied: Ensure your account has the correct permissions to generate or view API keys. Contact your administrator if needed.
- Further Assistance: Contact support at [email protected].