PrimeCal-Entwicklerdokumente

Code-Backed API Referenz nach Produktbereich

Dieser Abschnitt spiegelt die tatsächliche Produkt-Feature-Map wider. Es dokumentiert direkt das Nicht-Administrator-Backend von den NestJS-Controllern und DTOs, mit Anforderungseinschränkungen, Authentifizierungsnotizen, Beispielaufrufen usw Vorbehalte bei der Umsetzung.

Nicht-AdministratorbereichController-unterstütztJWT, API Schlüssel und Agent-AuthentifizierungMCP enthalten

Beginnen Sie hier

Übersicht

API-Übersicht

Basispfad, Authentifizierungsmodi, Bereichsregeln und die vollständige Produktbereichskarte.

Authentifizierung

Authentifizierungs-API

Registrierung, Onboarding, Anmeldung, MFA, OAuth, Aktualisierungsablauf und Benutzerschlüssel API.

Profile

Benutzer-API

Profileinstellungen, Sprache, Berechtigungs-Bootstrap und Freigabehilfen.

Automatisierung

Automatisierungs-API

Regeln, Auslöser, Bedingungen, Aktionen, Prüfprotokolle, Genehmigungen und Webhooks.

KI-Agenten

Agent-API

Agent CRUD, bereichsbezogene Berechtigungen, ausgegebene Schlüssel und die MCP Laufzeitendpunkte.

Produktbereiche

Planung

Kalender, Ereignisse, Aufgaben

Kalender, Gruppen, Freigabe, Ereignis-CRUD und Wiederholung, Kommentare, Aufgaben-CRUD und Beschriftungen.

Integrationen

Externe Synchronisierung

Anbieterstatus, OAuth Übergabe, externe Kalenderzuordnung, Trennung und manuelle Synchronisierung.

Benutzerkontrollen

Benachrichtigungen, Persönliche Protokolle, Compliance

Posteingang und Einstellungen, Audit-Feed und Zusammenfassung, Datenschutzexporte, Anfragen und Einwilligungen.

Planungsdomäne

Organisationen, Ressourcen, Buchung

Organisationen, Rollen, Ressourcen, Reservierungskalender, Reservierungen und öffentliche Buchungen.

Plattform

Plattform-API

Zustand, Bereitschaft, Funktionsflags, Überwachung, Frontend-Fehleraufnahme und Sicherheitsberichte.

Empfohlener Lesepfad

1. Lesen Sie API Übersicht.
2. Wählen Sie den Produktbereich aus, der der von Ihnen erstellten benutzerorientierten Funktion entspricht.
3. Verwenden Sie die Endpunkttabellen und DTO-Regeln, bevor Sie Clientanfragen verknüpfen.
4. Behandeln Sie alles unter Admin-Controllern als separate Dokumentationsoberfläche.

Swagger-Benutzeroberfläche

Bei Aktivierung durch das Backend wird die generierte Swagger-Benutzeroberfläche unter /api/docs bereitgestellt. Produktionsbereitstellungen können dieser Route die HTTP-Basisauthentifizierung voranstellen.