Knot MaaS API is an implementation of Instant System's APIs. This API allow a MaaS provider to integrate its solution with Knot, allowing to use Knot kick-scooter through others applications. An API Key is required, please contact us to get one.
The following features are implemented:
There is no reservation for the moment. The billing / payment isn't implemented yet, so only a usage for free user (for example when a organization pay the usage for its employee) can be done through this API.
Return past and ongoing user's bookings.
minStartDate | string <date-time> |
maxStartDate | string <date-time> |
{- "bookingInformations": [
- {
- "id": "string",
- "status": "FUTURE",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "startLocation": {
- "lat": 45.18,
- "lon": 5.23
}, - "endLocation": {
- "lat": 45.18,
- "lon": 5.23
}, - "vehicle": {
- "id": "254",
- "name": "ARV005",
- "type": "KICK_SCOOTER"
}, - "actions": [
- {
- "type": "RETURN_VEHICLE"
}
], - "price": {
- "amount": 0,
- "vat": 0,
- "currencyCode": "string"
}
}
]
}
Return the specified user booking.
id required | string Example: 235 Identifier of the booking. |
{- "bookingInformations": {
- "id": "string",
- "status": "FUTURE",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "startLocation": {
- "lat": 45.18,
- "lon": 5.23
}, - "endLocation": {
- "lat": 45.18,
- "lon": 5.23
}, - "vehicle": {
- "id": "254",
- "name": "ARV005",
- "type": "KICK_SCOOTER"
}, - "actions": [
- {
- "type": "RETURN_VEHICLE"
}
], - "price": {
- "amount": 0,
- "vat": 0,
- "currencyCode": "string"
}
}
}
Starts the usage of this mobility service by unlocking the vehicle.
lat | string User's current latitude. |
lon | string User's current longitude. |
vehicle | string This is the vehicle identifier, which can come from several mechanisms: Raw content of a QrCode read in a kick-scooter, serial name (written on the kick-scooter) typed by the user or the vehicle identifier. |
{- "lat": "string",
- "lon": "string",
- "vehicle": "string"
}
{- "bookingInformations": {
- "id": "string",
- "status": "FUTURE",
- "startDate": "2019-08-24T14:15:22Z",
- "endDate": "2019-08-24T14:15:22Z",
- "startLocation": {
- "lat": 45.18,
- "lon": 5.23
}, - "endLocation": {
- "lat": 45.18,
- "lon": 5.23
}, - "vehicle": {
- "id": "254",
- "name": "ARV005",
- "type": "KICK_SCOOTER"
}, - "actions": [
- {
- "type": "RETURN_VEHICLE"
}
], - "price": {
- "amount": 0,
- "vat": 0,
- "currencyCode": "string"
}
}
}
This service provides the real time status of the stations for station-based vehicle fleet.
{- "stationsStatus": [
- {
- "id": "400",
- "numVehiclesAvailable": 12,
- "numVehiclesDisabled": 0,
- "numDocksAvailable": 10,
- "numDocksDisabled": 0,
- "isInstalled": true,
- "isRenting": true,
- "isReturning": true
}
]
}