Files
2026-07-08 16:15:37 +02:00

3.7 KiB

M027 — API-Keys + Tarif-Feature-Gates

Block: Block 1 · Modul 27 Pflichtenheft-Quelle: block1.md Abschnitte 27.12, 27.13

Ziel

Mandanten-API-Keys mit Scope, 365-Tage-Rotation, Last-100-Requests-Log. Tarif-Feature-Gates: Funktion in tieferem Tarif → Klartext + Pricing-Link.

Pflichtenheft-Bezug

  • 27.12 — API-Keys (Name, Scope, Rotation, Rate-Limit, Last-100-Requests)
  • 27.13 — Tarif-Gates: Klartext + Link zu hivegrid.de/pricing; PWA/mobile ohne In-App-Checkout

Abhängigkeiten

  • Vorbedingung: M001 (Audit), M006 (Feature-Flag-Engine)
  • Wird benötigt von: M161-M163 (Public-API), M153 (Subscriptions)

Out of Scope

  • OAuth2-für-Drittanbieter (Phase 2, Anti-Liste)
  • Schreibendes Public-API (Phase 2, Anti-Liste)

Erfolgskriterium

API-Key-Anlage einmal sichtbar (Sicherheits-Standard); Rate-Limit greift bei >1000 Req/h; Tarif-Gate führt auf Pricing-Link statt In-App-Checkout.

Hinweise für Slice-Planung

  • Hashed-Storage (nur Hash in DB, Plain einmal beim Anlegen)
  • Last-100-Requests-Ringbuffer pro Key
  • Pricing-Link in t() (kein Hardcoded-URL)

Definition of Done — verbindlich (siehe AGENTS.md + docs/INTEGRATION-CONTRACTS.md)

Dieses Milestone gilt nur dann als erledigt, wenn alle Punkte wahr sind. Bei Verstoß: PR-Block.

Erreichbarkeit

  • Sidebar-Eintrag in apps/web/app/application/sidebar/ mit Permission-Gate (oder explizit dokumentiert, warum nur Inline-Verlinkung) — Gruppe gemäß docs/INTEGRATION-CONTRACTS.md §1
  • Route unter korrektem URL-Pattern (INTEGRATION-CONTRACTS §3)
  • Breadcrumb für Detail-Routes (§4)
  • Mobile-Tab-Bar-Eintrag falls mobile-relevant (§13)
  • Customer-Portal-Sichtbarkeit explizit konfiguriert (§14)

Querschnitt-Wiring

  • Audit läuft (auto via M001 oder manuell)
  • Activity-Stream via logActivity bei relevanter Aktion (M045)
  • Notifications via notify() (M011), nicht direkt
  • Search-Index registriert in indexed-entities.ts, falls suchbar
  • Permission-Filter via withTenantScope() + withPermission() (M004)
  • Feature-Flag-fähig (M006) — Modul ohne Deploy abschaltbar

Code-Layer-Disziplin (PR-Block)

  • Loader baut View-Model; UI-Component empfängt nur VM + Actions
  • Keine Prisma-/Server-Imports in packages/ui-app/**
  • Subframe-Output via Adapter, nicht direkt importiert
  • Alle UI-Texte als i18n-Keys (M003-Build-Lint blockt sonst)

Tests

  • Unit-Test für VM-Builder mit Zod-Schema-Validierung
  • Smoke-Test e2e/smoke/<modul>.spec.ts (Login → Route → Hauptaktion → erwartetes UI)
  • Hot-Swap-Drill grün (Smoke-Test gegen packages/ui-mock aus M017)
  • Visual-Regression-Snapshot der Hauptansicht (M016)

Klartext (User-facing)

  • Fehler-Texte aus M002-Catalog (kein HTTP-Code im UI)
  • Empty-State mit Klartext + nächster Aktion
  • Loading-State mit Klartext (kein leerer Spinner)
  • Permission-Denied → 404, nicht 403 (Bauprinzip A.5.3)

Rollback-Pfad

  • Forward-Only-DB-Migration mit Inverse-SQL als Kommentar
  • Atomic-Slice-Commits (TC-Default)
  • Feature-Flag vorhanden, um das Modul ohne Deploy auszuschalten

Klick-Pfad zum Prüfen (für User)

Wenn dieses Milestone fertig ist, prüft der User die Funktion über folgenden Pfad:

  1. Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
  2. Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
  3. Hauptaktion ausführen
  4. Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)

Falls etwas nicht erreichbar ist: Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.