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.
- If two-factor authentication (2FA) is enabled, complete the additional verification step.
2. Access the API Section
- Once logged in, locate the API Settings or Developer Tools section.
- This is usually found in the top navigation menu or under the account settings dropdown.
- Click on API Keys or API Access.
3. Create or View Your API Key
-
If you already have an API key:
- You will see your existing API key listed.
- Click the Copy button next to the key to copy it to your clipboard.
-
If you don’t have an API key yet:
- Click the Generate API Key button.
- Follow any additional steps, such as naming the key or setting permissions.
- The key will be displayed on the screen.
Important: Copy and securely save this key, as it will only be shown once.
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.
- Key Not Visible: API keys may only be shown once during creation. If you lose it, generate a new one.
- Further Assistance: Contact support at [email protected].