Platform API

Platform és futási felület

Egészségügyi szondák, funkciójelzők, figyelés és biztonsági jelentések feldolgozása

Ezek a végpontok az alapvető termékvezérlőkön kívül helyezkednek el, és támogatják a futásidejű állapotot, a mérőszámokat, ügyfél telemetria, nyilvános funkciójelzők és biztonsági jelentések feldolgozása.

Többnyire nyilvános útvonalakEgészség és felkészültségPrometheus-metrikákBiztonsági jelentések

Forrás

• Alkalmazásvezérlő: backend-nestjs/src/app.controller.ts
• Funkciójelző vezérlő: backend-nestjs/src/common/feature-flags.controller.ts
• Felügyeleti vezérlő: backend-nestjs/src/monitoring/monitoring.controller.ts
• Biztonsági jelentésvezérlő: backend-nestjs/src/common/security/security-reports.controller.ts
• Honeypot vezérlő: backend-nestjs/src/api-security/controllers/honeypot.controller.ts
• DTO-k: backend-nestjs/src/monitoring/dto/frontend-error-report.dto.ts, backend-nestjs/src/common/security/dto/security-report.dto.ts

Hitelesítés és hatókör

• Ezen az oldalon minden végpont nyilvános.
• Ezek az útvonalak infrastruktúrára vagy visszaélések észlelésére irányulnak, nem pedig végfelhasználói szolgáltatás API-k.
• A API felhasználói kulcs létrehozása és kezelése a Authentication API dokumentumban található.

Végpont referencia

Egészség és elérhetőség

módszer	Útvonal	Cél	Kérjen vagy érdeklődjön	Auth	Forrás
GET	/api/	Root alkalmazás válasza.	Egyik sem	Nyilvános	app.controller.ts
GET	/api/health	Életesség szonda.	Egyik sem	Nyilvános	app.controller.ts
GET	/api/healthz	Legacy liveness alias.	Egyik sem	Nyilvános	app.controller.ts
GET	/api/ready	Készenléti szonda DB ellenőrzéssel.	Egyik sem	Nyilvános	app.controller.ts

Zászlók és felügyelet

módszer	Útvonal	Cél	Kérjen vagy érdeklődjön	Auth	Forrás
GET	/api/feature-flags	Az aktuális funkciójelző pillanatképének visszaadása.	Egyik sem	Nyilvános	common/feature-flags.controller.ts
GET	/api/monitoring/metrics	Vissza a Prometheus metrika szövegét.	Egyik sem	Nyilvános	monitoring/monitoring.controller.ts
GET	/api/monitoring/metrics/json	Visszatérési mutatók JSON.	Egyik sem	Nyilvános	monitoring/monitoring.controller.ts
POST	/api/monitoring/frontend-errors	Foglalja le a frontend hibajelentéseket.	Törzs: frontend error payload	Nyilvános	monitoring/monitoring.controller.ts

Biztonsági jelentések és Honeypots

módszer	Útvonal	Cél	Kérjen vagy érdeklődjön	Auth	Forrás
POST	/api/security/reports/ct	Tanúsítvány-átlátszósági vagy hasonló biztonsági jelentéseket kaphat.	Test: biztonsági jelentés rakomány	Nyilvános	common/security/security-reports.controller.ts
POST	/api/security/reports/csp	CSP-sértési jelentések fogadása.	Test: biztonsági jelentés rakomány	Nyilvános	common/security/security-reports.controller.ts
GET	/api/security/honeypot/admin-login	Visszaélés-észlelési csapda útvonala.	Egyik sem	Nyilvános	api-security/controllers/honeypot.controller.ts
POST	/api/security/honeypot/submit	Visszaélés-észlelési csapda küldési útvonala.	Egyik sem	Nyilvános	api-security/controllers/honeypot.controller.ts

Kérjen alakzatokat

Frontend hibajelentések

FrontendErrorReportDto

• source: kötelező karakterlánc, legfeljebb 180 karakter
• message: kötelező karakterlánc, legfeljebb 400 karakter
• stack: opcionális karakterlánc, legfeljebb 10000 karakter
• url: opcionális karakterlánc, legfeljebb 400 karakter
• severity: nem kötelező error|warn|info
• details: opcionális objektum

Biztonsági jelentések

• A biztonsági jelentés végpontjai elfogadják a SecurityReportDto hasznos adat alakzatot a backend-nestjs/src/common/security/dto/security-report.dto.ts-tól.
• A vezérlő report és cspReport stílusú rakományokat is elfogad.

Példahívások

Olvasási készenlét

curl "$PRIMECAL_API/api/ready"

Funkciójelzők lekérése

curl "$PRIMECAL_API/api/feature-flags"

Küldjön be előtérbeli hibát

curl -X POST "$PRIMECAL_API/api/monitoring/frontend-errors" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "calendar-view",
    "message": "Week view render failed",
    "severity": "error",
    "url": "https://app.primecal.eu/app"
  }'

Válasz és viselkedés megjegyzések

• POST /api/monitoring/frontend-errors a következőt adja vissza: 202 Accepted.
• A biztonsági jelentés végpontjai a következőt adják vissza: 204 No Content.
• A funkciójelzők szándékosan nyilvánosak, így a kezelőfelület alakíthatja a bejelentkezés előtti folyamatokat.

Legjobb gyakorlatok

• A /api/health és a /api/ready a telepítési és terheléselosztási szondákhoz használható, az ügyfelek felé néző irányítópultokhoz ne.
• Tartsa biztonságban a frontend hibaadatait. Ne szivárogtasson ki tokeneket, e-mail címeket vagy nyers titkokat a details-ban.
• A mézesedény-útvonalakat csak belső visszaélési jelként kezelje. Ezek nem a végfelhasználók számára dokumentálandó termék API-k.
• Az ügyfeleknél különítse el a megfigyelhetőségi aggályokat a terméklogikától. Ezeknek az útvonalaknak általában platform SDK-rétegekben kell élniük, nem pedig modulokban.