Architecture and technical integration

This page describes how the systems connect in a full Platform API integration and the technical basics of the interface.

Architecture

Your MaaS app talks to your MaaS backend, and the ioki Passenger App talks to the ioki backend. The two backends exchange data with each other through the Platform API and Webhooks.

flowchart LR
    subgraph partner [Partner side]
        MA[MaaS app]
        MB[MaaS backend]
    end
    subgraph ioki [ioki side]
        IA[ioki Passenger App]
        IO[ioki backend]
    end
    MA --> MB
    IA --> IO
    MB -->|Platform API| IO
    IO -->|Webhooks| MB

• Platform API. Your MaaS backend calls the ioki backend to create users, request and book rides, and read data.
• Webhooks. The ioki backend pushes updates (for example ride and vehicle information) to your MaaS backend.

Technical basics

Aspect	Detail
Data format	JSON
Interface	REST API and webhooks
Data exchange	Encrypted HTTPS connection
Authentication	Bearer access token together with client credentials (X-Client-Identifier and X-Client-Secret)

The APIs and webhooks are documented using the OpenAPI Specification in the API Docs of ioki Platform; see the Platform API and Webhooks pages for details.