Developer Guides

Learn how to integrate Blyxo API into your development workflow

Get started with the Blyxo API in 3 simple steps:

Step 1: Generate API Key

Create an API key from your Blyxo dashboard:

  1. Log in to your Blyxo account at dev.blyxo.app
  2. Navigate to Settings → API Keys
  3. Click "Create API Key"
  4. Enter a name and description for your key
  5. Set the expiration period (default: 90 days)
  6. Click "Create Key"
  7. Important: Copy your API key immediately - it will only be shown once!

Security Note: Your API key will be displayed only once after creation. Store it securely in a password manager or environment variables. Never commit API keys to version control.

Step 2: List Your Sites

curl -X GET https://api.blyxo.app/api/v1/sites \
  -H "X-API-Key: key_your_api_key_here"

Step 3: Trigger a Scan

curl -X POST https://api.blyxo.app/api/v1/sites/SITE_ID/scans \
  -H "X-API-Key: key_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "config": {
      "rules": ["wcag-aa"],
      "priority": "high"
    }
  }'