API Übersicht

PrimeCal API Referenz

Die Nicht-Administrator-API-Karte

Diese Referenz wird direkt aus den Backend-Controllern und DTOs erstellt. Es dokumentiert die Benutzer- und Integrationsoberfläche API und schließt absichtlich die Admin-Controller aus und Nur-Administrator-Routen.

Basispfad: /apiJWT, Cookie, API Schlüssel und Agent-AuthentifizierungCodegestützte DTO-EinschränkungenAdmin-Oberfläche ausgeschlossen

Umfang

• Enthalten: Nicht-Administrator-Controller und Nicht-Administrator-Produktrouten
• Ausgeschlossen: /api/admin/* Controller und Nicht-/admin Routen, die mit AdminGuard geschützt sind
• Quelle der Wahrheit: NestJS-Controller, DTOs und Schutzverhalten in backend-nestjs/src

Basis-URL und Authentifizierungsmodell

Thema	Notizen
Basispfad	Alle Beispiele gehen von /api aus.
Swagger-Benutzeroberfläche	Generierter Swagger kann bei Aktivierung unter /api/docs bereitgestellt werden
Browsersitzungen	Verwenden Sie Aktualisierungscookies plus CSRF für mutierende Anfragen
Inhaberauthentifizierung	Authorization: Bearer <token>
Benutzerschlüssel API	Unterstützt auf Routen, die von JwtAuthGuard geschützt werden; senden Sie x-api-key oder Authorization: ApiKey <token>
Agentenschlüssel	Erforderlich für die Laufzeit von MCP; Senden Sie x-agent-key, x-agent-token oder Authorization: Agent <token>

Produktbereichs-Referenzkarte

Seite	Produktbereich	Höhepunkte
Authentifizierung API	Authentifizierung	Registrieren, Anmelden, Onboarding, MFA, OAuth, Benutzerschlüssel API
Benutzer API	Benutzer und Profil	Profileinstellungen, Sprache, Berechtigungen, Benutzersuche
Persönliche Protokolle API	Persönliche Protokolle	Audit-Feed und Zusammenfassung
Konformität API	Datenschutz und Compliance	Exporte, Anfragen, Zustimmungen, Richtlinienakzeptanz
Kalender API	Kalender	Kalender, Gruppen, Teilen
Ereignis API	Veranstaltungen	Ereignis CRUD, Wiederholung, Kommentare
Aufgaben API	Aufgaben	Aufgaben, Beschriftungen, Filterung
Automatisierung API	Automatisierung	Regeln, Audit-Protokolle, Genehmigungen, Webhook-Trigger
Externe Synchronisierung API	Externe Synchronisierung	Anbieterstatus, OAuth, Zuordnungen, Synchronisierung erzwingen
Agent API	KI-Agenten und MCP	Agenten, Bereiche, Schlüssel, MCP Laufzeit
Benachrichtigungen API	Benachrichtigungen	Posteingang, Einstellungen, Regeln, Stummschaltungen, Threads
Organisation API	Organisationen	Mitgliedschaft, Rollen, Farbe, Löschvorschau
Ressource API	Ressourcen	Ressourcentypen, Ressourcen, öffentliche Token
Buchung API	Reservierungen und öffentliche Buchung	Reservierungskalender, Reservierungen, öffentliche Buchung
Plattform API	Plattform	Gesundheit, Flags, Metriken, Sicherheitsberichte

Beispiele für den Schnellstart

Inhaberauthentifizierung

export PRIMECAL_API=https://api.primecal.eu
curl "$PRIMECAL_API/api/calendars" \
  -H "Authorization: Bearer $TOKEN"

Benutzerschlüssel API

curl "$PRIMECAL_API/api/tasks" \
  -H "Authorization: ApiKey $USER_API_KEY"

Agentenschlüssel

curl "$PRIMECAL_API/api/mcp/actions" \
  -H "Authorization: Agent $AGENT_KEY"

Best Practices

• Gruppieren Sie Client-Code nach Produktbereich, nicht nur nach Controller-Pfad.
• Nutzen Sie die DTO-Einschränkungen auf diesen Seiten als Quelle der Wahrheit für Ihre Anfrage und Ihren Vertrag.
• Behandeln Sie Nur-Administrator-Routen als separate Dokumentationsoberfläche.
• Erstellen Sie Integrations-UIs aus Live-Katalog-Endpunkten, sofern vorhanden, z. B. Automatisierungs-Smart-Values ​​oder dem Agentenkatalog.