Getting Started with the Vehicle Management API

Manage your data for Drivewyze programs.

Introduction

The Drivewyze Vehicle Management API (sometimes referred to as the VMAPI) is a RESTful API for managing data necessary for the operation of the Drivewyze PreClear, e-Inspection, Safety Notifications, and Safety+ programs.

These programs are designed for companies managing commercial vehicles hauling cargo in North America to improve efficiency and safety. They allow drivers to bypass weigh stations or expedite inspections as well as receive “virtual road signs” about high risk areas and other value-add notifications. Additionally, customers managing fleets of vehicles have access to analytics about their drivers’ performance.

The programs are delivered on a Software-as-a-Service basis. Drivers access Drivewyze information through in-cab devices, including phones and tablets. In-cab devices and reseller backend systems are also in communication with Drivewyze services as part of the data exchange necessary for Drivewyze Programs .

The Vehicle Management API allows reseller client applications to:

  • Update information related to a trucking fleet such as its drivers and vehicles to keep it synchronized with the data in their own systems
  • Ensure vehicles and fleets are properly subscribed to Drivewyze programs
  • Manage the logins used to authorize and authenticate requests by mobile devices using Drivewyze services

The API follows standard REST design patterns and can be consumed by any client capable of communicating via HTTP 1.1. JSON is the preferred format for payloads and is used in our examples.

Key Entities

For a complete guide to all the entities and their properties, see the API reference guide

Reseller

A Reseller is a Drivewyze Partner that has entered into an agreement to incorporate Drivewyze services and sell them to other trucking businesses.

The Reseller is responsible for maintaining data around their customers and keeping Drivewyze in sync with that data. In most cases, the Reseller is synonymous with the Partner.

📘

Accessing and Modifying the Reseller Object

A Partner can only view their Reseller entity with an HTTP GET request or update it field at a time using an HTTP PATCH request.

Fleet

A Fleet represents a single customer and is a collection of vehicles that are subscribed to Drivewyze services. In practical terms, this is a business that owns or operates vehicles.

The Fleet entity represents the legal entity that decided to purchase Drivewyze programs and services, it is often referred to as the customer by Drivewyze integration Partners.

For more information about Fleets see Managing Fleets.

Vehicle

The Vehicle entity represents a single truck (power unit) that is subscribed to Drivewyze services.

A Vehicle will belong to only one Fleet.

For more information about Vehicles see: Managing Vehicles

Driver

A Driver represents a person that is driving a vehicle.

Drivers are a shared resource that may belong to multiple fleets.

For more information about Drivers see: Managing Drivers

FleetImage

The FleetImage is an entity that can be used to apply a single vehicle image to multiple vehicles without having to duplicate the binary data.

For more information about FleetImages see: Managing Vehicle Images

Group

A Group is used to organize and categorize Vehicles and Drivers in a taxonomy that is useful to operators of the Fleet.

A Fleet may create Groups based on the type of vehicle, or the routes that are traveled. This can be useful for larger Fleets with lots of Vehicles for special reporting or subscriptions purposes. This is an optional entity.

🚧

Vehicle Groups

VehicleGroup is a deprecated entity that has a similar function to Group. It is recommended you use the Group entity instead.

For examples as to how to use groups see: Using Groups

Logins and Credentials

The Vehicle Management API also allows clients to manage the Logins and Credentials used for authenticating mobile apps that consume Drivewyze services.