API Keys

API keys are the primary method for authenticating with the HesedVid API. They provide secure, programmatic access to your HesedVid resources.

Overview

API keys allow you to authenticate API requests without requiring user sessions. They’re perfect for:

• Server-to-server communication
• Automated scripts and tools
• CI/CD pipelines
• Third-party integrations

Authentication

Include your API key in the X-Api-Key header for all API requests:

curl -X GET "https://api.hesedvid.com/v1/api/{orgID}/videos" \
  -H "X-Api-Key: hv_live_123456789abcdefghijklmnopqrstuvwxyz"

const response = await fetch('https://api.hesedvid.com/v1/api/{orgID}/videos', {
  headers: {
    'X-Api-Key': 'hv_live_123456789abcdefghijklmnopqrstuvwxyz',
    'Content-Type': 'application/json'
  }
});

API Key Types

HesedVid supports different types of API keys with varying access levels:

Key Format

API keys follow this format:

• Live keys: hv_live_ prefix (for production)
• Test keys: hv_test_ prefix (for development)
• Length: 32 characters after the prefix

Example: hv_live_123456789abcdefghijklmnopqrstuvwxyz

Security Best Practices

Error Handling

Common API key related errors:

Rate Limiting

API key operations are rate-limited:

Rate limit information is included in response headers:

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9999
X-RateLimit-Reset: 1640995200

Getting Your API Keys

API keys are created and managed through the HesedVid dashboard:

1. Log in to your HesedVid dashboard
2. Navigate to Settings → API Keys
3. Create a new key with appropriate permissions
4. Copy the key immediately (it won’t be shown again)
5. Store securely in your application

Integration Examples

Node.js/Express

const express = require('express');
const app = express();

app.get('/api/videos', async (req, res) => {
  try {
    const response = await fetch('https://api.hesedvid.com/v1/api/{orgID}/videos', {
      headers: {
        'X-Api-Key': process.env.HESEDVID_API_KEY,
        'Content-Type': 'application/json'
      }
    });

    const data = await response.json();
    res.json(data);
  } catch (error) {
    res.status(500).json({ error: 'Failed to fetch videos' });
  }
});

Python

import os
import requests

def get_videos():
    headers = {
        'X-Api-Key': os.getenv('HESEDVID_API_KEY'),
        'Content-Type': 'application/json'
    }

    response = requests.get(
        'https://api.hesedvid.com/v1/api/{orgID}/videos',
        headers=headers
    )

    return response.json()

cURL

# Set your API key as an environment variable
export HESEDVID_API_KEY="hv_live_123456789abcdefghijklmnopqrstuvwxyz"

# Use in requests
curl -X GET "https://api.hesedvid.com/v1/api/{orgID}/videos" \
  -H "X-Api-Key: $HESEDVID_API_KEY" \
  -H "Content-Type: application/json"

Troubleshooting

Common Issues

Key not working:

• Verify the key is copied correctly
• Check if the key has expired
• Ensure you’re using the correct environment

Permission denied:

• Verify the key has access to the requested environment
• Check if the key type matches your use case
• Ensure the organization ID is correct

Rate limited:

• Implement exponential backoff
• Consider caching responses
• Contact support for higher limits

Testing Your Key

# Test API key validity
curl -I "https://api.hesedvid.com/v1/api/{orgID}/environments" \
  -H "X-Api-Key: YOUR_API_KEY"

# Should return 200 OK if valid

What’s Next?

• Video Upload - Upload your first video
• Video Playback - Stream videos with your API key
• Analytics - Monitor usage and performance