Środowiska
DUST działa jako trzy wdrożone usługi. Większość integracji potrzebuje tylko DUST API; do AuthD można dotrzeć przez ścieżki API /api/auth/*.
| Usługa | URL | Przeznaczenie |
|---|---|---|
| Aplikacja internetowa DICE | https://dice4.dustid.io | Oficjalny internetowy interfejs użytkownika do przepływów pracy DUST. |
| DUST API | https://apid.dustid.io | Podstawowe API. Dokumentacja referencyjna Scalar pod adresem /api/docs. |
| AuthD | https://authd.dustid.io | Konta, organizacje, sesje, OIDC, konta usług. |
Ścieżki API
Dział zatytułowany „Ścieżki API”DUST API udostępnia platformę pod następującymi ścieżkami głównymi:
| Ścieżka | Zastosowanie |
|---|---|
/api/auth/token | Wymiana klucza API AuthD na token Bearer. |
/api/auth/jwks | Pobieranie JWKS AuthD przez DUST API. |
/api/v1/* | Podstawowe operacje DUST API. |
/api/openapi.json | Generowana specyfikacja OpenAPI udostępniana przez API. |
/api/docs | Interaktywna dokumentacja referencyjna Scalar. |
Pełny, generowany katalog punktów końcowych znajdziesz w dokumentacji referencyjnej API, a nagłówki kontekstu żądania dołączane do każdego wywołania — w artykule Konwencje.
Punkty końcowe kondycji
Dział zatytułowany „Punkty końcowe kondycji”DUST API udostępnia standardowe sondy kondycji w katalogu głównym serwera (nie pod /api):
| Ścieżka | Sprawdzenie | Zachowanie w razie awarii |
|---|---|---|
/livez | Żywotność — proces działa. | Zawsze 200, dopóki serwer działa. |
/readyz | Gotowość — obejmuje zapytanie do bazy danych i odpowiedź. | 503, jeśli sprawdzenie bazy danych się nie powiedzie lub przekroczy 2-sekundowy limit czasu. |
/healthz | Alias sprawdzenia gotowości. | Tak samo jak /readyz. |
Wszystkie trzy zwracają { "status": "ok", "timestamp": "…" }, gdy usługa działa prawidłowo; sprawdzenia gotowości zwracają { "status": "error", … } ze statusem 503, gdy tak nie jest. Monitory dostępności kieruj na /readyz (lub /healthz).