PrimeCal fejlesztői dokumentumok

Kóddal alátámasztott API Referencia termékterület szerint

Ez a rész a tényleges termékjellemző térképet tükrözi. Közvetlenül dokumentálja a nem rendszergazdai háttérprogramot a NestJS-vezérlőktől és a DTO-któl kérési megszorításokkal, hitelesítési megjegyzésekkel, példahívásokkal és végrehajtási figyelmeztetések.

Nem rendszergazdai hatókörVezérlővel támogatottJWT, API kulcs és ügynök hitelesítésMCP tartalmazza

Kezdje itt

Áttekintés

API áttekintése

Alapútvonal, hitelesítési módok, hatókör-szabályok és a teljes termékterület-térkép.

Hitelesítés

Authentication API

Regisztráció, belépés, bejelentkezés, MFA, OAuth, frissítési folyamat és felhasználói API kulcsok.

Profil

Felhasználói API

Profilbeállítások, nyelv, engedélyezési rendszerindítási és megosztási segédek.

Automatizálás

Automatizálási API

Szabályok, eseményindítók, feltételek, műveletek, ellenőrzési naplók, jóváhagyások és webhookok.

AI-ügynökök

Agent API

Agent CRUD, hatókörű engedélyek, kiadott kulcsok és a MCP futásidejű végpontok.

Termékterületek

Tervezés

Naptár, Események, Feladatok

Naptárak, csoportok, megosztás, események CRUD és ismétlődés, megjegyzések, feladat CRUD és címkék.

Integrációk

Külső szinkronizálás

Szolgáltató állapota, OAuth átadás, külső naptár-leképezés, leválasztás és kézi szinkronizálás.

Felhasználói vezérlők

Értesítések, Személyes naplók, Megfelelőség

Beérkező levelek és beállítások, ellenőrzési hírcsatorna és összefoglaló, adatvédelmi exportálások, kérések és hozzájárulások.

Domain ütemezése

Szervezetek, Források, Foglalás

Szervezetek, szerepkörök, erőforrások, foglalási naptárak, foglalások és nyilvános foglalások.

Platform

Platform API

Állapot, készenlét, funkciójelzők, figyelés, előtér-hibák feldolgozása és biztonsági jelentések.

Ajánlott olvasási útvonal

1. Olvassa el a API áttekintést.
2. Válassza ki azt a termékterületet, amely megfelel az Ön által kialakított, felhasználóbarát funkciónak.
3. Használja a végponttáblázatokat és a DTO-szabályokat az ügyfélkérések bekötése előtt.
4. Az adminisztrátori vezérlők alatt lévő bármit külön dokumentációs felületként kezelje.

Swagger UI

Ha a háttérrendszer engedélyezi, a generált Swagger felhasználói felület a /api/docs címen kerül kiszolgálásra. Az éles telepítések a HTTP Basic hitelesítést helyezhetik el az útvonal előtt.