Sandbox API

The Carvoyant Sandbox API provides a good way to build applications against the Carvoyant system without relying on a physical vehicle. This might be because you want to try out the Carvoyant platform before committing to a purchase, or simply because it’s easier to develop against a known set of vehicle data. In either case, there are a few things you need to know to get started using it.

The Environment

The sandbox environment contains all elements of the production environment with the exception of the systems that collect data from actual vehicles on the road (and therefore doesn’t support physical devices). Here are the endpoints that you need to get started:

This is the driver dashboard where you can register a Carvoyant account in the sandbox and create vehicles to test against.

This is the endpoint that you make API requests against. The resource space effectively matches production. Anywhere in our documentation where you see you would replace with

This is our OAuth2 authorization endpoint where you can authorize your API to access your sandbox Carvoyant account.

This is our traffic simulator for generating vehicle data in the sandbox environment.

Provisioning a Key

If you don’t already have a developer account, you will need to register one here:

On the registration screen, make sure that the Sandbox API checkbox is selected:


If you already have a developer account you can easily add a sandbox key to it as well. After logging in, select “My Account” from the top right area and then click the “Applications” heading item:


Next you need to decide whether you want to add the key to an existing application or create a new one. It’s probably easier to create a new one. Decide which you want to do and add the Sandbox API key.

Interactive API

Just like the production API, you can use the online interactive API to make calls against the Sandbox API. After creating your Sandbox API key, switch over to the Interactive API and change the API to Sandbox API.


Vehicle Data

Now that you’re all set up to make calls against the Sandbox environment, you need some data! If you haven’t already, add a vehicle to your Carvoyant account (or more than one - or more than one Carvoyant account, whatever you need). In the Sandbox environment, since there is no actual data collection, there are no hardware devices configured in the system so you will always leave the Device Id on the vehicle blank.

There are two ways that you can load up some data against your sandbox vehicles.

Inbound API

In the sandbox environment, we’ve opened up the ability for anyone to submit their own data through the API. This allows you to create very complex trips to meet whatever requirements you have for testing. An example of the data sets to submit in order to create a simple trip is below. You would pass each of these, in order, into the dataSet endpoint. All of them submitted would create a simple trip. The key is to ensure that the trip starts and contains only a single ignition ON event and ends with an ignition OFF event. Further, in order to track mileage correctly on the vehicle, you need to ensure that a GEN_TRIP_MILEAGE datum is in the ignition OFF message.

Sample JSON Messages:


Traffic Simulator

Having detailed access to submitting different data is nice, but sometimes you just want to simulate a couple of simple trips. To do that, we’ve created a simulation tool that allows you to select the vehicle you want, enter some points on a map, adjust some basic parameters if you want to, and then process the trip against your vehicle. This will send the data over just like a real vehicle would.

Open a web browser to and log in with your Carvoyant user credentials. Once you’re logged in, set up a trip by clicking the start and end point on the map. When it’s all set, click “Schedule Trip” and your trip will be sent to the Carvoyant platform.