Getting started - TSP

As a Transport Service Provider (TSP) you are able to integrate to our API and thereby offer your ticket products for resale by following the instructions given below:

  1. Form from your transport data GTFS feeds (.txt files in a .zip file package), and publish the zip file to an open endpoint

    The transit data in GTFS format contains feeds among others on routes, schedules, stops, ticket types and customer groups. With help of this transit data the retailer (e.g. MaaS operator) using our API are able to present your ticket products to the end users, i.e clients in an accurate and presentable manner.

    Please familiarise yourself  with the GTFS feeds and their required attributes here (GTFS Attiributes).

  2. Integrate your ticket system to the Maritime MaaS API

    By integrating to our API, you enable ticket queries and purchase of tickets through the API to your ticket system.

    Please see the technical documentation, incl. booking endpoint descriptions here (Technical documentation).

  3. Ensure that your ticket system generates ticket data that is in alignment with our ticket data model recommendation

    The ticket data plays a crucial role when retailer show the purchased ticket to the client. Our ticket data model makes sure that the ticket data contains all relevant information that is needed for using and understanding the terms of usage of a single ticket.

    Please familiarise yourself with the ticket data model recommendation here (Ticket Data model)

  4. At the moment to retrieve any data via the API requires a valid agreement between the transport service provider and the retailer. Please make sure that you sign a deal with the retailer to-be. After this, the retailer contacts us and follows the instructions given in this wiki and delivered by us during the process.

    We recommend that you discuss also these topics:

  • Resale commission

  • Customer service responsibilities 

  • The account of sold tickets to service provider

 

Regarding any questions related to usage of the API or technical implementation, please contact us by sending email to: maritime-maas-support@forumvirium.fi 



Vesiliikenteen MaaS -hanke - Maritime MaaS project
Marite MaaS API documentation 2021-2022
Forum Virium Helsinki & City of Helsinki