API für Entwickler

Schnellstart

In drei Schritten zur ersten Antwort:

1. API-Key erstellen unter Einstellungen → API-Keys (wird nur einmal angezeigt).
2. Den Schlüssel im Authorization-Header mitsenden.
3. Eine Anfrage an einen Endpunkt stellen – z. B. den Threat-Lookup:

curl -X POST https://api.spamexx.com/api/v1/check/lookup \
  -H "Authorization: Bearer sx_ihr_schluessel" \
  -H "Content-Type: application/json" \
  -d '{"type":"domain","value":"example.com"}'

Authentifizierung

Jede Anfrage braucht einen API-Key im Authorization-Header (alternativ X-API-Key). Den Schlüssel erstellen Sie unter Einstellungen → API-Keys.

Authorization: Bearer sx_ihr_schluessel

Kontingent & Rate-Limit

Pro Mandant gilt ein monatliches Anfrage-Kontingent und ein Rate-Limit pro Minute – beides aus Ihrem API-Tarif. Erschöpftes Kontingent oder überschrittene Rate beantwortet die API mit 429.

Nur erfolgreiche (authentifizierte) Anfragen zählen gegen das Kontingent. Abgelehnte Anfragen (401/403/429) werden nicht gezählt.

Threat-Lookup

Prüft einen einzelnen Indikator gegen die Spamexx-Bedrohungsdatenbank und liefert Verdikt, Score und Treffer-Flag.

curl -X POST https://api.spamexx.com/api/v1/check/lookup \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"domain","value":"example.com"}'

{
  "type": "domain",
  "value": "example.com",
  "verdict": "clean",
  "score": 0.0,
  "matched": false
}

Content-Prüfung

Lässt eine eingereichte Nachricht durch die Spam- und Virenprüfung laufen und liefert ein Verdikt (zustellen / Quarantäne / abweisen) samt Score.

curl -X POST https://api.spamexx.com/api/v1/check/message \
  -H "Authorization: Bearer $KEY" \
  -H "Content-Type: application/json" \
  -d '{"from":"absender@example.com","subject":"Hallo","body":"Nachrichtentext"}'

{
  "verdict": "deliver",
  "score": 2.1,
  "is_spam": false,
  "is_virus": false
}

Tariflimits & Verbrauch

Liefert die dem API-Key zugeordneten Tariflimits je Produktlinie samt aktuellem Verbrauch: API-Kontingent (genutzt/Limit) und Rate, Online/SaaS (Domains & Postfächer genutzt/Limit, Aufbewahrung) sowie Backup/Failover. Nicht gebuchte Linien werden weggelassen.

curl https://api.spamexx.com/api/v1/limits \
  -H "Authorization: Bearer $KEY"

{
  "tenant_id": "…",
  "period": "2026-06",
  "unlimited": false,
  "api":   { "plan": "Community", "requests": { "used": 0, "max": 5000 }, "remaining": 5000, "rate_per_min": 10 },
  "saas":  { "plan": "Enterprise", "domains": { "used": 1, "max": 50 }, "mailboxes": { "used": 6, "max": 500 }, "retention_days": 365 },
  "spool": { "plan": "Basic", "domains": { "used": 0, "max": 3 }, "spool_retention_hours": 72 }
}

Antwort-Felder

Die Endpunkte liefern ein generisches Verdikt ohne Details zu den eingesetzten Prüfverfahren.

Fehler

Fehler kommen als JSON mit einem error-Feld; der HTTP-Status zeigt die Kategorie.

Best Practices

Häufige Fragen