Docs
Ctrl+K

Changelog

API v1 verziókövetés, kompatibilitási ígéret, deprecation policy és változásnapló.

Verziós policy#

A Bokko Public API szemantikus verziózást követ. A jelenlegi stabil verzió: v1.

  • Major változás (v1 → v2): nem visszakompatibilis — külön URL prefix, átmeneti párhuzamos futtatás
  • Minor változás (v1.0 → v1.1): visszakompatibilis bővítés (pl. új opcionális mező, új endpoint)
  • Patch: hibajav, belső változás, a contract nem módosul

Mi a contract#

Az alábbiak képezik az API contract részét — ezekre támaszkodhatnak az integrátorok:

  • Endpoint URL és HTTP method
  • Request és response mezők neve és típusa (required mezők esetén)
  • Error code értékek, HTTP státuszuk és retryable flagjük
  • Capability nevek és hatókörük
  • Webhook event nevek és a payload.event mező értéke

Mi NEM contract#

Az alábbiakra nem vállalunk stabilitási garanciát:

  • Opcionális mezők hozzáadása vagy eltávolítása (ha eddig sem volt required)
  • Hibaüzenet szövege (message mező) — csak a code stabil
  • Meta extension mezők (meta.truncated, meta.returnedSlots stb.)
  • Rate limit kvóta értékek (a struktúra stabil, az értékek nem)
  • Belső Firestore path-ok, Cloud Function nevei

Jelenlegi v1 contract összefoglaló#

Contract dimenzióDarabszám
Dokumentált endpoint14
Stabil error code27
Webhook event8
Capability8
Rate limit group5

Deprecation policy#

Ha egy endpoint, mező vagy capability kivezetésre kerül:

  1. Minimum 6 hónappal előre közöljük a deprecationt
  2. Az érintett endpointok Deprecation HTTP response headert kapnak (RFC 8594)
  3. A tervezett kikapcsolás dátumát Sunset HTTP response header jelzi
  4. Email értesítés a Pro előfizető regisztrált contact emailjére
Tipp
Jelenleg nincs aktív deprecation. Ha az első deprecation bekövetkezik, a backend headerek és az email pipeline élesítése a deprecation event részeként történik. A fenti policy a kommunikációs ígéret, nem a már beüzemelt infrastruktúra leírása.

v1.0.0 — 2026-05-05 — Kezdeti publikáció#

Az első stabil nyilvános kiadás. Az alábbi számok erre a release-re vonatkoznak és rögzítve maradnak — nem frissülnek automatikusan ha a contract bővül.

  • 14 dokumentált endpoint
  • 27 stabil error code
  • 8 webhook event
  • 8 capability
  • 5 rate limit group

Endpointok:

  • POST /availability/search
  • GET /bookings
  • POST /bookings
  • GET /bookings/{bookingId}
  • POST /bookings/{bookingId}/cancel
  • GET /bookings/{bookingId}/events
  • GET /services
  • GET /staff
  • GET /subscription
  • GET /webhooks/config
  • PUT /webhooks/config
  • DELETE /webhooks/config
  • POST /webhooks/config/rotate-secret
  • GET /webhooks/deliveries