Using API Keys
Learn how to authenticate with the API using API keys.
API keys provide a way to authenticate with the Rowlogy API without needing a user session. This is useful for programmatic access, scripts, and integrations.
Obtaining an API Key
You can generate and manage your API keys from your user settings page.
- Navigate to your profile settings.
- Find the "API Keys" or "Developer Settings" section.
- Generate a new API key. Make sure to copy the key immediately, as it may not be shown again for security reasons.
Making Authenticated Requests
To authenticate your API requests, you need to include your API key in the Authorization header of your HTTP request. The header should be formatted as follows:
Authorization: Bearer <YOUR_API_KEY>
Replace <YOUR_API_KEY> with the actual API key you generated.
Example
Here's an example using curl:
curl -H "Authorization: Bearer <YOUR_API_KEY>" https://rowlogy.com/api/your-username/your-project-id/contentSecurity Best Practices
- Keep your API keys confidential: Treat your API keys like passwords. Do not share them publicly or commit them to version control.
- Use environment variables: Store your API keys in environment variables for your applications instead of hardcoding them.
- Limit permissions (if applicable): If the platform allows, create API keys with only the necessary permissions for the intended task.
- Revoke unused keys: Regularly review and revoke API keys that are no longer needed.
If you suspect an API key has been compromised, revoke it immediately and generate a new one.