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.

• OpenAPI Specification
• Documentation
• SwaggerUI

API Data Model (JSON Schema)

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

• Schemas
• Documentation

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

Docked bike sequence

Booking state flow

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

Taxi states

Bike

Also compatible with scooter and other micromobility providers.

Rental car

Car sharing

Docked bike

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

Examples

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

Examples repository