Skip to main content

Workflow

If you don't know where to start you're in the right place. Here we will walk you through the basic steps of integrating MaaS API into your platform.

Before you start​

Before you start building your integration make sure that:

  • You have obtained the credentials from Dott.
  • Your requests to the MaaS API are authenticated.
  • It is recommended that your requests contain a meaningful User-Agent header, e.g., User-Agent: freenow.

Overview​

The steps you need to take to integrate Dott's MaaS API.

Setup phase​

This is the starting phase of your integration. Here you can find out what data should be retrieved before you can start managing rides with Dott vehicles.

Request the region information​

Learn about the rules and restrictions in your operations region.

This part includes:

  1. Getting the regionID for the operations region
  2. Retrieving the region configuration
  3. Receiving a price list for the selected region

Find out requirements for a user account​

More information on why to create a user account can be found here.

The steps for getting the full information required to create a user account:

  1. Getting mandatory user data for creating an account with Dott
  2. Obtaining the details of the legal agreements in the specified region
  3. Getting requirements for the user documents that have to be verified before a Dott vehicle can be started

Get Dott's fleet and riding data​

There are 2 ways a user can start a ride with a Dott vehicle:

  • asset based: a user sees a vehicle on the street and scans its QR code
  • map based: a user chooses a vehicle among available Dott rentals in a partner app

For a better user experience we encourage you to display the following data:

Riding phase​

The steps that have to be implemented when a user selects a Dott vehicle in a partner app or scans a QR code on a physical rental and chooses to start a ride.

Create a user​

In order to start a trip, you must first create a user account and confirm the person's eligibility to ride a vehicle. The user account you create must adhere to the requirements retrieved in the setup phase.

The process includes the following steps:

  1. Create a user account within the Dott system

  2. Request a user to take the actions below:

    • agree to the legal agreement

    • provide the required document if it's demanded by the municipality

      info

      Dott totally relies on the partner app to provide the UX to handle these two events.

Manage trips​

For a successful ride at least two operations have to be completed:

  • starting a trip
  • ending a trip
note

Currently Dott does not support vehicle reservations.

Explore our guides to learn about how to start and end trips.

Provide proper parking evidence​

The carelessly parked vehicles may quickly become a big nuisance for the cities by blocking sidewalks and entrances to the buildings. This is the reason why certain municipalities restrict parking zones and require the proof of a ride having been terminated in a legitimate area.

Dott conforms to the rules set up by the cities and provides a set of APIs to help a user to declare the proper parking.

  • To upload a photo of a parked vehicle use the CreateTripParkingPhoto API endpoint

  • If a user is unable to take a picture use the SkipTripParkingPhoto API endpoint to give a reason why it cannot be done

    info

    The two above endpoints are mutually exclusive.

Get a trip invoice​

Read how to get a trip invoice and whether parking fines are included into it.

Apply for access to production​

As soon as you've finished your implementation and have everything tested on the Dott's staging environment you can apply for access to our production environment.