Authentication

Overview

SudoMock uses API key authentication for all API requests. Each key is tied to your account and tracks usage against your credit balance.

Generating API Keys

Generate API keys from the Dashboard. You can create multiple keys for different purposes:

1. Navigate to Dashboard → API Keys
2. Click "Generate New Key"
3. Enter a descriptive name (e.g., "Production", "n8n Integration", "Development")
4. Optionally set an expiration date
5. Copy and save the key immediately—it's shown only once!

Using API Keys

Include your API key in the X-API-KEY header with every request:

1
curl -X POST "https://api.sudomock.com/api/v1/renders" \
2
  -H "X-API-KEY: sm_a1b2c3d4e5f6..." \
3
  -H "Content-Type: application/json" \
4
  -d '{ "mockup_uuid": "...", "smart_objects": [...] }'

Key Format

All SudoMock API keys follow this format:

1
sm_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6a7b8c9d0
2
 │  └─────────────────────────────────────────────────────────────────┘
3
 │                            64 character random string
4
 └── Prefix: "sm_" identifies SudoMock keys

Security Best Practices

Environment Variables

1
# .env.local (Never commit this file!)
2
SUDOMOCK_API_KEY=sm_your_production_key_here
3
4
# In your code (Node.js example)
5
const apiKey = process.env.SUDOMOCK_API_KEY;
6
7
// Python example
8
import os
9
api_key = os.environ.get("SUDOMOCK_API_KEY")

Revoking Keys

If a key is compromised or no longer needed, revoke it immediately:

1. Go to Dashboard → API Keys
2. Find the key you want to revoke
3. Click the Revoke button
4. Confirm the action

Authentication Errors

1
{
2
  "success": false,
3
  "detail": "Invalid or missing API key"
4
}