API Authentication

Secure your API requests with proper authentication.

Getting Your API Key

1. Go to **Settings** > **API Keys**
2. Click **"Generate New Key"**
3. Name your key (e.g., "Production App")
4. Select the key scope
5. Copy and securely store your key

**Important**: API keys are only shown once. Store them securely.

Using Your API Key

Include your API key in the Authorization header:

curl -X GET "https://api.hellobeacon.ai/v1/brands" \
  -H "Authorization: Bearer YOUR_API_KEY"

API Key Scopes

Read-Only

Access to read data:

• GET endpoints only
• Suitable for dashboards and reporting

Read-Write

Full access:

• All GET, POST, PUT, DELETE endpoints
• Suitable for full integrations

Key Management

Rotating Keys

1. Generate a new key
2. Update your applications
3. Delete the old key

Revoking Keys

If a key is compromised:

1. Go to **Settings** > **API Keys**
2. Click **"Revoke"** on the compromised key
3. Generate a new key

Security Best Practices

1. **Never expose keys in client-side code**
2. **Use environment variables**
3. **Rotate keys regularly**
4. **Use minimum required scope**
5. **Monitor API usage for anomalies**

OAuth 2.0 (Enterprise)

Enterprise plans support OAuth 2.0 for:

• User-level authentication
• Delegated access
• Third-party integrations

Contact support to enable OAuth for your organization.