API Áttekintés

PrimeCal API Referencia

A nem rendszergazda API Térkép

Ez a referencia közvetlenül a háttérvezérlőkből és a DTO-kból épül fel. Dokumentálja a felhasználó és integráció felé néző API felület, és szándékosan kizárja az adminisztrátori vezérlőket és csak adminisztrátori útvonalak.

Alap elérési út: /apiJWT, cookie, API kulcs és ügynök hitelesítésKóddal támogatott DTO megszorításokAdminisztrátori felület kizárva

Hatály

• Tartalmazza: nem rendszergazdai vezérlők és nem rendszergazdai termékútvonalak
• Kizárva: /api/admin/* vezérlők és nem /admin útvonalak, amelyeket AdminGuard véd
• Az igazság forrása: NestJS-vezérlők, DTO-k és őrző viselkedés a backend-nestjs/src-ban

Alap URL és hitelesítési modell

Téma	Megjegyzések
Alapútvonal	Minden példa feltételezi, hogy /api
Swagger UI	A generált Swagger a /api/docs címen szolgálható ki, ha engedélyezve van
Böngésző munkamenetek	Használjon frissítési cookie-kat és CSRF-t a mutáló kérésekhez
Bemutató hiteles	Authorization: Bearer <token>
Felhasználói API kulcsok	A JwtAuthGuard által őrzött útvonalakon támogatott; küldje el x-api-key vagy Authorization: ApiKey <token>
Ügynökkulcsok	MCP futási időhöz szükséges; x-agent-key, x-agent-token vagy Authorization: Agent <token> küldése

Termék-terület referenciatérkép

oldal	Termékterület	Kiemelések
Hitelesítés API	Hitelesítés	regisztráció, bejelentkezés, belépés, MFA, OAuth, felhasználói API kulcsok
Felhasználó: API	Felhasználó és profil	profilbeállítások, nyelv, engedélyek, felhasználói keresés
Személyes naplók API	Személyes naplók	ellenőrzési hírfolyam és összefoglaló
Megfelelőség API	Adatvédelem és megfelelés	export, kérések, hozzájárulások, irányelvek elfogadása
Naptár API	Naptár	naptárak, csoportok, megosztás
Esemény API	Események	esemény CRUD, ismétlődés, megjegyzések
Tasks API	Feladatok	feladatok, címkék, szűrés
Automatizálás API	Automatizálás	szabályok, ellenőrzési naplók, jóváhagyások, webhook trigger
Külső szinkronizálás API	Külső szinkronizálás	szolgáltató állapota, OAuth, leképezések, kényszerített szinkronizálás
ügynök API	AI ügynökök és MCP	ügynökök, hatókörök, kulcsok, MCP futási idő
Értesítések API	Értesítések	beérkező levelek, beállítások, szabályok, némítások, szálak
Szervezet API	Szervezetek	tagság, szerepek, szín, törlés előnézet
Forrás API	Erőforrások	erőforrástípusok, erőforrások, nyilvános tokenek
Foglalás API	Foglalás és nyilvános foglalás	foglalási naptárak, foglalások, nyilvános foglalás
Platform API	Platform	egészség, zászlók, mutatók, biztonsági jelentések

Gyors kezdési példák

Bemutató hiteles

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

Felhasználói API kulcs

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

Ügynök kulcs

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

Legjobb gyakorlatok

• Csoportosítsa az ügyfélkódot termékterület szerint, nem csak a vezérlő elérési útja szerint.
• Használja az ezeken az oldalakon található DTO megkötéseket az igazság kérés-szerződéses forrásaként.
• A csak adminisztrátori útvonalakat külön dokumentációs felületként kezelje.
• Integrációs felhasználói felületek létrehozása élő katalógus-végpontokból, ahol vannak, például automatizálási intelligens értékekből vagy ügynökkatalógusból.