MyWay Support API (1.0.0)

Download OpenAPI specification:

Internal API for the MyWay support agent. It answers the questions support gets most: is this car parked?, has this booking been paid?, what does this garage offer?

All endpoints are read-only and read the shared MyWay Firestore of the environment (vickyparking-dev or vickyparking-prod). The backend (myway-cloud) stays authoritative; this API only interprets booking and garage documents.

Authentication

Send the environment's access key in the access-key header on every request. Requests without a valid key get 401.

Environments

Environment Base URL
Development https://support-api-gateway-5cvbz26i.ew.gateway.dev
Production https://support-api-gateway-dllekmh7.ew.gateway.dev

Response envelope

Successful responses look like { "message": "...", "code": "...", "data": ... }. Errors look like { "errorGroupCode": "...", "httpErrorCode": 404, "errorDetail": { "code": "...", "message": "..." } }.

Derived states

parkingState: parked, not_parked or unknown. Closed bookings are never parked. Statuses such as started_parked or overdue_will_depart mean parked; not_started, started_arrived or ended mean not parked. For plain started (garage without entrance gate) and subscription sessions the last gate passages decide; with no entrance recorded the state is unknown.

paymentState: paid (captured, nothing open), not_paid (open amount, failed, expired, unconfirmed or cancelled), pending (payment method authorised, not captured yet), refunded, no_payment_required (free, host-settled or written off) or unknown.

kind: park_direct (pay on exit, booking type direct) or reservation (shortTerm / longTerm).

Not available yet

Write actions from the support endpoint list (update plate or times, set parked, open gates, cancel, create bookings), garage availability and price calculation, occupancy, and the whitelist/workfloor status endpoints are planned for later releases.

Bookings

Bookings (Park Direct sessions and reservations) looked up by plate or id.

Search bookings by license plate

Finds bookings for a license plate. The plate is normalised the same way the backend does (case, spaces, dashes and accents are ignored), so AB-123-C and ab 123c match. By default only open (not closed) bookings are returned, newest start first.

Authorizations:
accessKey
query Parameters
licensePlate
required
string <= 20 characters

License plate in any formatting.

includeClosed
string
Default: "false"
Enum: "true" "false"

Also return closed bookings (history). At most 300 documents per plate are scanned.

limit
integer [ 1 .. 50 ]
Default: 20

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "BOOKINGS_RETRIEVED_SUCCESSFULLY",
  • "data": [
    ]
}

Booking details

Location, user contact, price, payment and Park Direct / reservation kind of one booking.

Authorizations:
accessKey
path Parameters
bookingId
required
string

Firestore bookings document id.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "BOOKING_RETRIEVED_SUCCESSFULLY",
  • "data": {
    }
}

Booking status and parking state

Authorizations:
accessKey
path Parameters
bookingId
required
string

Firestore bookings document id.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "string",
  • "data": {
    }
}

Booking payment status (paid / not paid)

Authorizations:
accessKey
path Parameters
bookingId
required
string

Firestore bookings document id.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "string",
  • "data": {
    }
}

Garages

Garage (spot) details.

Garage details

Address, capacity, facilities (charging, max height, …), booking types, rates and opening times.

Authorizations:
accessKey
path Parameters
garageId
required
string

Firestore spots document id.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "GARAGE_RETRIEVED_SUCCESSFULLY",
  • "data": {
    }
}

Health

Service health.

Service health check

Authorizations:
accessKey

Responses

Response samples

Content type
application/json
{
  • "message": "Service is healthy",
  • "data": {
    }
}