Skip to main content

LiDAR

Description

Welcome to the MayMobility LiDAR Data API documentation. This guide will help you access LiDAR data through the Batch API for your specific vehicle. Please follow the steps outlined below to retrieve and download LiDAR data efficiently.

There are two steps involved in successful download of a LiDAR data file.

Step 1. Endpoint to initiate the request. (#1 to #4 below)

step 2. Endpoint to download the file from step 1. (#2, #5 below)

1. Endpoint for Data Retrieval

To access LiDAR data through the Batch API, use the endpoint provided by the Fleet API team:

The endpoint accepts the following variables that need to be specified:

vehicle: The name of the vehicle for which you want to retrieve data.

startTime: Start timestamp for data retrieval. Note that the start time must not be a timestamp from the current day; it should be at least a day old.

endTime (optional): End timestamp for data retrieval. If not provided, the default end time is 30 seconds after the start time. The maximum end time allowed is 30 seconds.

ENDPOINT/lidar?vehicle=marinara&startTime=1690828364&endTime=1690828380

2. Authorization Token

To use the Batch API, you need to generate an authorization token. The token should have the following scope set for Batch operations:

Scope: Scope to get authorization to this endpoint might vary with other endpoints.

3. Data Age Limit

Please note that the requested logs cannot be older than 5 days. Data older than this duration will have been archived and will not be accessible through this API.

4. Output Format

The API will provide you with the filename of the generated ROSBAG file as output.

5. Downloading the File

Once the file is generated (estimated time within 5 minutes), you can use the following API to download the file by passing the filename parameter:

Download URL: ENDPOINT/download

Here, the filename is a variable containing the output filename from the previous API request.

Example Download URL:

ENDPOINT/download?filename=53494076-c6af-407d-8699-a17140d0b29f.bag

6. Download Expiry

Please be aware that the provided download link will be valid for only 10 minutes. Ensure you download the file within the specified timeframe before the link expires.

If you have any questions or require further assistance, please don't hesitate to reach out to us. We are here to help you access and utilize MayMobility's LiDAR data effectively.