An overview of the steps to start integrating mobility services using Lyko

• Step 1 : Define your needs and LYKO modules
• Step 2 : Request for a Lyko's test account
• Step 3 : Set up your Application, via the Dashboard
• Step 4 : Build your integration
• Step 5 : Contract for your live account

Lyko is a technology enabler, that provides a suite of APIs to simplify the development of monomodal, multimodal and intermodal platform. Whatever your needs, from trip planning to booking and payment, Lyko provides all you need to deliver an optimal and seamless experience into your platform.

• LYKO BOOK : Sell the offers of over 500 mobility providers (+10 transportation modes)
• LYKO PLAN : Integrate the planning of door-to-door trip, by combining various transportation modes at any scale (locally and internationally)
• LYKO PAY : Ensure a secure payment experience worldwide, by integrating our easy-to-use online payment solutions

Which API to choose ?

In order to address a wide range of business needs and to maximize the utility of each module, it is essential for you to understand the difference between Monomodal and Intermodal.

Monomodal Integrations (LYKO BOOK required / LYKO PAY Optional)

The first flow is characterized by the search, the comparison, and the booking of a journey including a single mode of transport. It offers the fastest search experience because the user already knows the transportation mode they are looking for.

Various use cases :

• Booking of Train tickets
• Booking of Car rentals
• Booking of Long-distance buses & Transfers (Airport, Ski…)
• Booking of Taxis and ride-hailing services
• Booking of Ferry (Coming soon)
• Booking of EV charging stations (Coming soon)

Regardless of the type or number of monomodal journeys you want to integrate on your platform, the LYKO BOOK module is necessary to manage reservations.

Intermodal Integrations (LYKO PLAN required / LYKO BOOK & PAY Optional)

Contrary to path monomodal, this second option is characterized by the combination of different modes of transport on a single journey. This second path covers all the trip of our user from the first to the last kilometer. For example, it could be possible for your user to plan a door-to-door trip including, both the reservation of a VTC and a train ticket.

Various use cases:

• Integration of an intermodal trip planner
• Planning, booking and payment of trips combining unlimited modes of transport

  In order to provide your customers with the most optimal door-to-door journey, it is imperative that you use our LYKO PLAN module, including our trip planner. You are then free to add our LYKO BOOK module, if you want to integrate the booking of offers, when selecting the route by your user.

In order to test our APIs, you need to request a Lyko account from our sales team, giving the e-mail address you wish to assign as administrator. Once your Lyko account has been created by our team, you will receive an email containing a link to verify your email address and set a password.

As a reminder, you can only have a single Lyko account, including one (or more) project(s), referred to as “Applications”. Each application is designated by the name of your platform/company, a period of access (limited or unlimited) and a right of access to the BOOK, PLAN and/or PAY APIs.

On each Application, we provide you with a unified dashboard, enabling you to :

• track API performance (requests, end-users, reservations)
• configure your application (API keys, activation of mobility providers)
• invite members of your organization to manage different parts of your application

1 - Generate your API Keys

Every API request you send to Lyko is processed via an API ID linked to your application. For an API request to succeed, you need to generate an API key and authenticate your API requests.

To generate a new API key :

• Go to the Staging dashboard | Production dashboard of the Application of your choice
• Go to the Settings ➡ Application on the left of the dashboard
• Click on the Add button in the “API Key” box on the right.

A new API key will be automatically created and linked to your Application. You have after the possibility to consult the list and delete the API Keys.

2 - Activate the mobility service providers

In order to access the mobility offers of our mobility providers, you must activate them via your Lyko account.

For this, nothing could be simpler:

• Go to the Staging dashboard | Production dashboard of the Application of your choice
• Go to the Settings ➡ Application on the left of the dashboard
• Click the Edit button in the “Mobility Service Providers” insert at the bottom of the screen
• For each mode of your choice, click on the mode of transport to reveal the complete list of suppliers. You will have the choice to activate or deactivate one by one or all mobility providers.
• Do not forget to save the modification by clicking on the “Save” button at the bottom of the “Mobility Service Providers”.

3 - Authenticate your APIs requests

Select...
curl -X GET https://api.lyko.tech/v2.1/addresses?text=Paris -H 'X-Api-Key: my_api_key'
of course, where my_api_key is your own API key

4 - Give access to other team members (optional)

From the dashboard of each Application, you have the possibility to invite members of your organization, referred to as “Administrator”. For each new administrator, you will be completely free to assign them different roles, corresponding to the different accesses on your Application.

To invite a new member :

• Go to the Staging dashboard | Production dashboard of the application of your choice
• Go to the Settings ➡ Administrator on the left of the dashboard
• Click the Add button
• Fill in the email and choose from the different roles offered.
• Click Add

The new administrator receives an email with a link to verify their email address and set a password for their Lyko account.

A live account allows you to create and validate the booking of the mobility offer from your users using Lyko. For the request, you will need to get back in touch with your Sales representative. He will send you the contract, including

• the quotation, based on the pricing of each LYKO modules
• the terms and conditions
• an information sheet about our company to fill

When you sign the contract, we create you access to the production environment.

The first flow is characterized by the search, the comparison, and the booking of a journey including a single mode of transport. It offers the fastest search experience for the user who already knows the transportation mode they are looking for.

For reminder, this second integration is characterized by the combination of different modes of transport on a single journey. This second path covers all the trip of our user from the first to the last kilometer. To illustrate this use case, we will imagine a scenario where the user looks for a plan a door-to-door trip, including both the VTC and train.

In this part, learn how to accept the payment of your users ➡

If you don't have a payment system, Lyko can provide you its module Lyko Pay features, that allow you the possibility to add and manage payment methods for each of your users. To add a payment method for your users, you have the choice of:

• Integrating a webview/iframe to display a form to your users
• Integrating the Stripe SDK for web or mobile application

For offering the significantly better user experience, we recommend opting for the second solution (integrate the Stripe SDK).

How it works?

You will need a secret, which you can retrieve by using the endpoint: GET /users/{userId}/payments/methods/preparations. This endpoint will provide you with the secret to use with the Stripe SDK, as well as an ID (the preparationId).

Once you have retrieved the payment method ID, you will be able to associate this payment method ID with your user using the endpoint: POST /users/{userId}/payments/methods. The method property should be the payment method ID returned by Stripe. The preparation property should be the preparationId returned by the first endpoint.

In this part, learn how to successfully manage user attributes ➡

As you know, any order requires being linked to a main user. The main user will be considered to be the one who does the order. He is often the owner of the account. In this section, we will see how you can allow the main user to:

• Manage their user profile
• Manage their addresses
• Manage their Loyalty/Reduction cards
• Manage their payment methods

In this part, learn how to successfully manage passenger attributes ➡

To offer the best experience for your main user, we give them the possibility to manage a list of usual passengers in your system. For reminder, the main user will be considered to be the one who does the order. He is often the owner of the account. In this section, we will see how you can allow them to:

• Manage their passengers
• Manage their passenger's Loyalty/Reduction cards

In this part, learn how to successfully add additional features ➡

To enhance the complete experience of your application, you'll find in this section the steps you need to retrieve or update a specific location, all orders or information concerning your project (i.e. the application).

• Place
• Global orders
• Project

In this part, learn how to stay informed at any time ➡

So crucial for a successful integration with Lyko, the Webhooks API allows you to subscribe to events happening in a Lyko account with your integration installed. Rather than making an API call when an event happens in a connected account, Lyko can send an HTTP request to an endpoint you configure. In real time, you receive alerts and take timely actions based on the events triggered as :

• The creation of new user
• The creation of new order
• The update of passengers
• etc.

Summary of this section:

• Creating webhooks
• Retrieving webhooks details
• Retrieving webhooks list
• Updating webhooks
• Deleting webhooks

The section allows users to generate and manage unique API keys for their projects. With these keys, users can securely access and interact with the project's data and resources through the API. By utilizing the Project API Keys feature, developers can authenticate and authorize their applications to make requests to the project's endpoints seamlessly.

• Creating API keys
• Retrieving API keys
• Retrieving API key list
• Updating API keys
• Deleting API keys