Authenticating with the Deltaray API
Last updated August 14, 2024
Before you can interact with the Deltaray API, you need to authenticate your requests to ensure secure access. Deltaray uses API keys for authentication, providing a simple and effective way to control access to your data and actions.
Obtaining an API Key
- Deltaray Account Settings: Log in to your Deltaray account and navigate to your account settings.
- API Keys Section: Locate the section for managing API keys.
- Generate a New Key: Click the button to generate a new API key. This will create a unique key for your account.
- Copy the Key: Copy the newly generated API key. Keep it in a secure location. API keys represent a significant security credential, so treat them with care and avoid sharing them with anyone.
Authenticating API Requests
- API Calls: When making API requests, include the API key in the request header. The specific header name might vary depending on the API client you're using and the Deltaray API documentation.
- Example:
- cURL: `curl -H 'Authorization: Bearer YOUR_API_KEY' ... `
- Python Requests: `requests.get(url, headers={'Authorization': 'Bearer YOUR_API_KEY'})`
- Security Best Practices:
- Never Hardcode Keys: Don't embed your API key directly in your code. Instead, store it securely in environment variables or a configuration file.
- Revoke Keys: When you no longer need a specific API key, revoke it from your Deltaray account settings to prevent unauthorized access.
- Rate Limiting: Deltaray may impose rate limits on API requests to prevent abuse. Be sure to consult the API documentation for rate limits and avoid exceeding them.
By following these authentication steps and best practices, you ensure that your API interactions are secure and that only authorized users and applications can access your Deltaray data.
Was this article helpful?