File size: 6,258 Bytes
0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef 2018c79 0b2f2ef |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 |
# API Authentication & Usage Guide
## 🔐 Setting Up API Key in Hugging Face Spaces
### Step 1: Generate Secure API Key
```bash
# Generate random API key (example methods)
node -e "console.log('sk-' + require('crypto').randomBytes(32).toString('hex'))"
# Or use Python
python -c "import secrets; print('sk-' + secrets.token_hex(32))"
```
### Step 2: Configure in HF Spaces
1. Navigate to your Space: `https://huggingface.co/spaces/your-username/space-name`
2. Click **"Settings"** tab
3. Click **"Variables"** section
4. Add this environment variable:
| Variable | Value | Description |
|----------|-------|-------------|
| `API_KEY` | `sk-your-secure-key-here` | Single API key for authentication |
### Step 3: Test Authentication
```bash
# Test without API key (should fail if authentication enabled)
curl -X POST https://your-space.hf.space/screenshot \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'
# Test with API key (should work)
curl -X POST https://your-space.hf.space/screenshot \
-H "Authorization: Bearer your-api-key-here" \
-H "Content-Type: application/json" \
-d '{"url": "https://example.com"}'
```
## 📊 Understanding Server Status Responses
### Normal Operation
```json
{
"status": "running",
"system": { "cpuUsage": "25%" },
"queue": { "activeRequests": 1, "queuedRequests": 0 }
}
```
### Server Busy (CPU > 95%)
```json
{
"status": "busy",
"error": "Server is currently overloaded",
"cpuUsage": "96%",
"queueLength": 3
}
```
### Queue Full Response
```json
{
"status": "busy",
"error": "Request queue timeout",
"queueLength": 10
}
```
## 🔄 Implementing Retry Logic
### JavaScript Retry Pattern
```javascript
async function screenshotWithRetry(url, options = {}, maxRetries = 3) {
for (let attempt = 1; attempt <= maxRetries; attempt++) {
try {
const response = await fetch('/screenshot', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your-api-key'
},
body: JSON.stringify({ url, ...options })
});
if (response.ok) {
return await response.blob();
}
if (response.status === 503) {
const error = await response.json();
if (error.status === 'busy') {
console.log(`Attempt ${attempt}: Server busy, retrying...`);
await new Promise(resolve => setTimeout(resolve, 2000 * attempt));
continue;
}
}
// Other errors, don't retry
throw new Error(`API Error: ${response.status}`);
} catch (error) {
if (attempt === maxRetries) throw error;
await new Promise(resolve => setTimeout(resolve, 1000 * attempt));
}
}
}
```
### Python Retry Pattern
```python
import time
import requests
from typing import Optional
def screenshot_with_retry(url: str, api_key: str, max_retries: int = 3) -> Optional[bytes]:
for attempt in range(1, max_retries + 1):
try:
response = requests.post(
'https://your-space.hf.space/screenshot',
headers={'Authorization': f'Bearer {api_key}', 'Content-Type': 'application/json'},
json={'url': url},
timeout=30
)
if response.status_code == 200:
return response.content
if response.status_code == 503:
error_data = response.json()
if error_data.get('status') == 'busy':
print(f"Attempt {attempt}: Server busy (CPU: {error_data.get('cpuUsage', 'N/A')})")
time.sleep(2 * attempt)
continue
response.raise_for_status()
except requests.RequestException as e:
if attempt == max_retries:
raise e
time.sleep(attempt)
return None
```
## 🚨 Rate Limiting & Best Practices
### Rate Limit Headers
The API returns rate limiting information:
```
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640995200
```
### Best Practices
1. **Implement exponential backoff** for retries
2. **Cache results** when possible
3. **Use appropriate image quality** (70-80% usually sufficient)
4. **Monitor your usage** via `/status` endpoint
5. **Handle queue timeouts** gracefully
### Production Usage Example
```javascript
class ScreenshotAPI {
constructor(apiKey, baseUrl) {
this.apiKey = apiKey;
this.baseUrl = baseUrl;
this.requestCount = 0;
this.resetTime = 0;
}
async screenshot(url, options = {}) {
// Check rate limit
if (this.requestCount >= 95 && Date.now() < this.resetTime) {
throw new Error('Rate limit approached, waiting...');
}
const response = await this.makeRequest('/screenshot', {
method: 'POST',
body: JSON.stringify({ url, ...options })
});
// Update rate limit tracking
this.requestCount = parseInt(response.headers.get('X-RateLimit-Remaining') || '0');
this.resetTime = parseInt(response.headers.get('X-RateLimit-Reset') || '0') * 1000;
return response;
}
async makeRequest(endpoint, options = {}) {
return fetch(this.baseUrl + endpoint, {
...options,
headers: {
'Content-Type': 'application/json',
'Authorization': `Bearer ${this.apiKey}`,
...options.headers
}
});
}
}
```
## 🔧 Troubleshooting
### Common Issues
| Error | Cause | Solution |
|-------|-------|----------|
| `401 Unauthorized` | Missing API key | Add `Authorization: Bearer` header |
| `403 Forbidden` | Invalid API key | Check key spelling/validity |
| `503 Service Unavailable` | Server overloaded | Implement retry with delay |
| `429 Too Many Requests` | Rate limit exceeded | Wait for reset time |
### Performance Optimization
- Use smaller dimensions for faster processing
- Lower quality settings for non-critical uses
- Batch requests with appropriate delays
- Monitor CPU usage via `/status` |