API overview

Ecovelo offers an API suitable for MaaS integration. It allows operators to create users and start a trip on their behalf. Our API also offers a way to implement a complexe invoicing system for bikesharing services.

In this documentation, you’ll learn how Ecovelo API is organized, how you can get the data you want and perform the actions you need. We’ll guide you from getting your API key to making your first request.

Warning

Mea culpa All objects related to a vehicle are called vehicule. Yes, we’re french and yes, we messed up a few years ago. As you can imagine it’s not a change easy to do now. It will probably be done in a major release one day.

Scope

This API is intended for end user (or cyclist) integration. It offers all the endpoints to create a fully featured Application.

It also includes the webhooks you may need to plug Ecovelo bike-sharing system into your own system, from synchronising users to running a custom invoicing system.

It is not intended for dashboard integration, system analytics or on-field maintenance Applications.

What you can do

  • User management, from creating to editing to deleting

  • Trip management, from listing the bikes to renting one

  • Billing management, from subscription to invoicing

  • Subscribe to all type of event via webhooks to plug your own logic to the system.