3.8 KiB
M162 — Public-API: API-Key-Auth + Scopes + Rate-Limit
Block: Block 7 · Modul 34 Pflichtenheft-Quelle: block7.md Abschnitte 34.1.4, 34.3
Ziel
4 Scopes: Read-Only (sensible Felder weggelassen), Read-Full (inkl. Notizen/Sensiblen Custom-Felder/Activities), Webhook-Inbound, Automation-Trigger. Phase 1: ein Schlüssel = ein Scope. Rate-Limit: 1000/h pro Key (50/sec tolerable Burst), 10K/h pro Mandant aggregiert, 100/min pro Webhook-Slug. Anpassbar bis 10K/h ohne Plattform-Admin. Standard X-RateLimit-Header. 90-Tage-Logs erfolgreiche Requests, 180-Tage-Fehler.
Pflichtenheft-Bezug
- 34.1.4-34.1.6 — Scopes
- 34.3 — Rate-Limiting + Logs
Abhängigkeiten
- Vorbedingung: M027 (API-Keys), M161
- Wird benötigt von: M163
Out of Scope
- Mehrfach-Scope-Schlüssel → Phase 2 (34.1.5)
- Granulare Modul-Scopes → Phase 2 (34.X.4)
- Schlüssel-Rotation-Workflow → Phase 2 (34.X.9)
Erfolgskriterium
Read-Only-Key sieht keine Notizen-Felder im Response; 1001. Request/h gibt 429 mit Retry-After; Field-Redact dokumentiert in OpenAPI.
Hinweise für Slice-Planung
- Field-Redact basierend auf Scope-Definition
- Rate-Limit via Redis-Counter
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
packages/ui-hivegrid/src/app-shell/sidebar.config.tsmit 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
logActivitybei 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-hivegrid/** - 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-mockaus 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:
- Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
- Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
- Hauptaktion ausführen
- Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)
Falls etwas nicht erreichbar ist: Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.