Shadow Guard
Developer Platform

ShadowGuard voor Developers

Integreer beveiligingsscanning in je workflow met onze API, SDK's en CLI. Van geautomatiseerde scans tot real-time bescherming.

7 endpoints

API Reference

Volledige REST API documentatie met authenticatie, scans, findings, suggesties, configuratie en webhooks.

Bekijk documentatie
npm packages

SDK Documentatie

JavaScript/TypeScript SDK voor runtime beveiliging en integratie met Next.js middleware.

Bekijk documentatie
npx ready

CLI Guide

Command-line tool voor scans, monitoring en MCP Server integratie met Claude Code.

Bekijk documentatie

Quick Start

In 3 stappen je eerste scan draaien via de API.

1

API Key aanmaken

Ga naar Instellingen → API Keys in je dashboard en maak een nieuwe API key aan. Ook in de free tier kun je direct starten.

# Je API key begint met sg_ sg_a1b2c3d4e5f6...
2

Authenticeren

Verifieer je API key en ontvang sessie-informatie.

POST/api/agent/auth
curl -X POST https://shadowguard.nl/api/agent/auth \
  -H "Content-Type: application/json" \
  -d '{"api_key": "sg_jouw_api_key"}'
Response
{
  "authenticated": true,
  "agent": {
    "key_id": "uuid",
    "name": "Mijn Agent",
    "permissions": ["read_scans", "write_scans", ...],
    "rate_limit": 100
  },
  "endpoints": {
    "scans": "/api/agent/scans",
    "scan_trigger": "/api/agent/scan",
    "findings": "/api/agent/findings",
    ...
  }
}
3

Eerste scan draaien

Start een beveiligingsscan op een van je sites.

POST/api/agent/scan
curl -X POST https://shadowguard.nl/api/agent/scan \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sg_jouw_api_key" \
  -d '{"site_id": "jouw-site-uuid"}'
Response 201
{
  "scan_id": "uuid",
  "site_id": "jouw-site-uuid",
  "url": "https://jouw-site.nl",
  "score": 82,
  "grade": "goed",
  "counts": {
    "critical": 0,
    "high": 1,
    "medium": 3,
    "low": 2
  },
  "findings_count": 6
}

Authenticatie

Alle API-verzoeken worden geauthenticeerd met een API key via Bearer token.

API Key formaat

API keys beginnen met sg_ gevolgd door een unieke hash. De volledige key wordt bij aanmaak maar eenmalig getoond.

Authorization: Bearer sg_a1b2c3d4e5f6g7h8...

Permissions

Elke API key heeft specifieke permissions. Je kunt deze instellen bij het aanmaken:

read_scansScans bekijken en lijst ophalen
write_scansNieuwe scans starten
read_findingsBevindingen ophalen
suggest_fixesSuggesties indienen en bekijken
read_configPlatformconfiguratie lezen
write_configConfiguratie aanpassen

Rate Limiting

Per key geldt een eigen rate limit policy. Bij overschrijding ontvang je een 429 Too Many Requests response.

Abuse & bot protection

API keys zijn gekoppeld aan gebruiker en tenant. ShadowGuard beschermt automatisch tegen misbruik:

  • Caps op actieve keys per gebruiker en per tenant
  • Daglimiet op key-aanmaak per gebruiker en extra IP-rate limit
  • Direct intrekken van keys in dashboard bij abuse of incidenten
  • Geblokkeerde gebruikers kunnen geen nieuwe API keys aanmaken

Klaar om te beginnen?

Start in de free tier, maak direct een API key aan en draai je eerste scan in minder dan 5 minuten.

Gratis account aanmakenBekijk API Reference