Foglalás API

Foglalás és nyilvános foglalás

Foglalási naptárak kezelése, foglalások létrehozása és nyilvános foglalási linkek közzététele

Ez az oldal a nem adminisztratív foglalási felületet csoportosítja: foglalási-naptári adminisztráció, belső foglalási CRUD és a közzétett erőforrás-jogkivonatokkal működő nyilvános foglalási végpontok.

JWT vagy felhasználói API kulcsA nyilvános foglalás nem hitelesítettSzerep alapú foglalási naptárakFoglalási hozzáférési őr

Hitelesítés és engedélyek

• A foglalási naptári útvonalak hitelesítést és szerepkör-ellenőrzést igényelnek.
• A belső foglaláshoz CRUD JwtAuthGuard plusz ReservationAccessGuard szükséges.
• A nyilvános foglalási útvonalak nem hitelesítettek, és az URL-ben található tokent használják.

Fontos forrás megjegyzés:

Végpont referencia

Foglalási naptár adminisztrációja

módszer	Útvonal	Cél	Kérjen vagy érdeklődjön	Auth
POST	/api/organisations/:id/reservation-calendars	Hozzon létre egy foglalási naptárt egy szervezet számára.	Elérési út: id, törzs: naptár hasznos terhelés	JWT vagy felhasználói API kulcs
GET	/api/organisations/:id/reservation-calendars	Sorolja fel egy szervezet foglalási naptárait.	Elérési út: id	JWT vagy felhasználói API kulcs
POST	/api/reservation-calendars/:id/roles	Rendeljen egy foglalási naptári szerepet egy felhasználóhoz.	Elérési út: id, törzs: userId,role	JWT vagy felhasználói API kulcs
DELETE	/api/reservation-calendars/:id/roles/:userId	Távolítsa el a foglalási naptári szerepkört.	Elérési út: id,userId	JWT vagy felhasználói API kulcs
GET	/api/reservation-calendars/:id/roles	Sorolja fel a szerepkörök hozzárendeléseit.	Elérési út: id	JWT vagy felhasználói API kulcs
GET	/api/users/reservation-calendars	Az aktuális felhasználó számára elérhető foglalási naptárak listája.	Egyik sem	JWT vagy felhasználói API kulcs
GET	/api/reservation-calendars/:id/my-role	Szerezze be az aktuális felhasználói szerepkört.	Elérési út: id	JWT vagy felhasználói API kulcs
GET	/api/reservation-calendars/:id/has-role/:role	Tesztelje, hogy az aktuális felhasználónak van-e szerepe.	Elérési út: id,role	JWT vagy felhasználói API kulcs
POST	/api/reservation-calendars/:id/reservations	Példa csak a szerkesztő által használható foglalási műveletre.	Elérési út: id	JWT vagy felhasználói API kulcs
GET	/api/reservation-calendars/:id/reservations	Példa szerkesztői vagy lektori foglalási lista műveletre.	Elérési út: id	JWT vagy felhasználói API kulcs
POST	/api/reservation-calendars/:id/reservations/:reservationId/approve	Példa jóváhagyási műveletre.	Elérési út: id,reservationId	JWT vagy felhasználói API kulcs

Belső foglalások

módszer	Útvonal	Cél	Kérjen vagy érdeklődjön	Auth
POST	/api/reservations	Hozzon létre egy foglalást.	Törzs: foglalási mezők	JWT vagy felhasználói API kulcs
GET	/api/reservations	A foglalások listája.	Lekérdezés: resourceId	JWT vagy felhasználói API kulcs
GET	/api/reservations/:id	Foglaljon egyet.	Elérési út: id	JWT vagy felhasználói API kulcs
PATCH	/api/reservations/:id	Frissítsen egy foglalást.	Elérési út: id, törzs: részleges foglalási mezők	JWT vagy felhasználói API kulcs
DELETE	/api/reservations/:id	Egy foglalás törlése.	Elérési út: id	JWT vagy felhasználói API kulcs

Nyilvános foglalás

módszer	Útvonal	Cél	Kérjen vagy érdeklődjön	Auth
GET	/api/public/booking/:token	Nyilvános foglalási metaadatok feloldása.	Elérési út: token	Nyilvános
GET	/api/public/booking/:token/availability	Olvassa el a rendelkezésre álló résidőket egy napra.	Elérési út: token, lekérdezés: date	Nyilvános
POST	/api/public/booking/:token/reserve	Nyilvános foglalás létrehozása.	Elérési út: token, törzs: foglalási mezők	Nyilvános

Kérjen alakzatokat

Foglalási naptárak

CreateReservationCalendarDto

• name: kötelező, 1..100 karakter
• description: opcionális, legfeljebb 500 karakter
• color: választható hatszögletű szín
• reservationRules: opcionális objektum
• editorUserIds: opcionális egyedi pozitív egész tömb
• reviewerUserIds: opcionális egyedi pozitív egész tömb

AssignRoleDto

• userId: kötelező pozitív szám
• role: kötelező enum ReservationCalendarRoleType

Belső foglalások

CreateReservationDto és UpdateReservationDto

• startTime: létrehozáskor kötelező, ISO dátum-idő
• endTime: létrehozáskor kötelező, ISO dátum-idő, startTime után kell lennie
• quantity: opcionális int, minimum 1
• customerInfo: opcionális objektum
• notes: opcionális megtisztított karakterlánc, legfeljebb 2048 karakter
• resourceId: létrehozáskor kötelező, minimum 1
• status: csak frissítési enum pending|confirmed|completed|cancelled|waitlist

Lekérdezés:

• ListReservationsQueryDto.resourceId: opcionális int >= 1

Nyilvános foglalás

CreatePublicBookingDto

• startTime: kötelező ISO dátum-idő
• endTime: kötelező ISO dátum-idő
• quantity: kötelező int, minimum 1
• customerName: kötelező karakterlánc
• customerEmail: kötelező e-mail
• customerPhone: kötelező karakterlánc
• notes: opcionális karakterlánc

Elérhetőségi lekérdezés:

• date: kötelező ISO-dátum karakterlánc

Példahívások

Hozzon létre egy foglalási naptárt

curl -X POST "$PRIMECAL_API/api/organisations/12/reservation-calendars" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Family bookings",
    "color": "#14b8a6",
    "editorUserIds": [18],
    "reviewerUserIds": [19]
  }'

Hozzon létre egy foglalást

curl -X POST "$PRIMECAL_API/api/reservations" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "startTime": "2026-04-01T08:00:00.000Z",
    "endTime": "2026-04-01T09:00:00.000Z",
    "resourceId": 21,
    "quantity": 1
  }'

Nyilvános foglalás létrehozása

curl -X POST "$PRIMECAL_API/api/public/booking/$PUBLIC_TOKEN/reserve" \
  -H "Content-Type: application/json" \
  -d '{
    "startTime": "2026-04-01T08:00:00.000Z",
    "endTime": "2026-04-01T09:00:00.000Z",
    "quantity": 1,
    "customerName": "Alex Example",
    "customerEmail": "alex@example.com",
    "customerPhone": "+36301112222"
  }'

Válasz és viselkedés megjegyzések

• A belső foglalásokat a ReservationAccessGuard védi.
• A foglalási naptári példa végpontjai szerepkörhöz kötöttek, de jelenleg scaffold szintű megvalósításban vannak.
• A nyilvános foglalási végpontok csak a közzétett tokent használják; nem igényelnek hitelesítést.

Legjobb gyakorlatok

• Használja a foglalási naptárakat a szereptudatos munkafolyamatokhoz és a /api/reservations a tényleges belső foglalási CRUD-hoz.
• Érvényesítse a rendelés dátumát ügyféloldalon a foglalási írások elküldése előtt.
• Kezelje a nyilvános foglalási tokeneket titokként. Újragenerálja őket, ha a linkek kiszivárognak vagy a személyzet megváltozik.
• Adjon hozzá díjkorlátozást vagy botellenes védelmet a nyilvános foglalási űrlapok előtt.