Authentication

API Keys

The Qamaq API uses API keys to authenticate requests. API keys are tied to your organization and can have different permission scopes to control what actions they can perform.

Creating API Keys

To create an API key:

1. 1Log in to your Qamaq dashboard
2. 2Navigate to Configurations > API Keys
3. 3Click "Create New API Key"
4. 4Give your key a descriptive name and select the appropriate scopes
5. 5Copy and securely store your API key - it won't be shown again

Using API Keys

Include your API key in the Authorization header using the Bearer scheme:

curl -X GET "https://api.qamaq.io/api/v1/me" \
  -H "Authorization: Bearer qmq_your_api_key"

const response = await fetch('https://api.qamaq.io/api/v1/me', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer qmq_your_api_key'
  }
});
const data = await response.json();

import requests

response = requests.get(
    'https://api.qamaq.io/api/v1/me',
    headers={'Authorization': 'Bearer qmq_your_api_key'}
)
data = response.json()

API Key Scopes

API keys can have different scopes that control what resources they can access:

Authentication Errors

If authentication fails, you'll receive one of these error responses:

Best Practices

• Use environment variables to store API keys, never hardcode them
• Create separate API keys for different applications or environments
• Use the minimum required scopes for each API key
• Rotate API keys periodically for better security
• Monitor API key usage in your dashboard
• Immediately revoke any API keys that may have been compromised