MaaS resources

Overview of resources available from MaaS Global, creators of WhimApp.

OpenAPI specification

This is an API specification of REST endpoints that a Transport Service Provider (TSP) should implement to offer their services through the WhimApp.

API Data Model (JSON Schema)

Based on JSON Schema standard, defines schema definitions for information exchanged between WhimApp and TSP.

Booking sequence diagrams

These diagrams show how User, WhimApp and TSP interact to perform booking with various modes of transportation (Taxi, Bike, etc)

Taxi sequence

Taxi sequence diagram

Docked bike sequence

Docked bike sequence diagram

Booking state flow

These diageams show the state transition for booking when journey is in progress.

Taxi states

Taxi states

Bike

Also compatible with scooter and other micromobility providers.

Bike states

Rental car

Rental car states

Car sharing

Car sharing states

Docked bike

⚠️ On hold state for docked bikes only supported in version v.1.2.0-future which is not yet deployed to production.

Docked states

Examples

See the repository for JSON examples of data exchanged between WhimApp and TSP

Examples repository