EROAD is currently transitioning to a framework that handles API configurations from within MyEROAD. This system is called Integrations.
MyEROAD Integrations let's you draw valuable EROAD data into your transportation management, payroll or other business software for consistent and accurate reporting.
The main advantage of using MyEROAD Integrations is greater privacy and security for our customers and far better ease of use for both our customers and those third parties with which our customers interact. Our design approach provides an open, standards-based interface using REST architecture and provides an easy and intuitive way of communicating with EROAD via the HTTPS protocol. Our API requests & responses are JSON.
Integrations, as a service, is available for customers on qualifying plans. Documentation for Integrations is wholly contained within MyEROAD.
'Legacy' APIs
The legacy APIs listed below should be used only if necessary, to avoid re-working of your integrations once the legacy infrastructure is retired.
- Partner Gateway
- Fuel API
- Customer API
- Vehicle Current State (deprecated - replaced with 'Current Machine')
- Fleet
- Geofence
- Driver
You can view, interact, and export clients to work with our Legacy APIs on SwaggerHub.
APIs enable you to integrate valuable EROAD data into your transportation management, payroll or other business software for consistent and accurate reporting.
The APIs and Partner Gateway are available for customers on the Premium plan. Our design approach provides an open, standards-based interface using REST architecture and provides an easy and intuitive way of communicating with EROAD via the HTTP protocol. You can use GET, POST, PUT, and DELETE requests to access the API endpoints.
Additional fees may apply to use of the EROAD APIs.
API Library
The following table lists EROAD APIs along with their descriptions and types. You can view, interact, and export clients to work with our APIs on SwaggerHub.
| API | Description | Type |
| Current Location | Provides current location information for vehicles. Allows you to retrieve the vehicle current status – including location, speed, distance readings, engine hours and I/O (auxiliary equipment PTO) activity. | JSON/XML |
| Vehicle and Fleet | Vehicle and Fleet - Create, Read, Update, Delete. Keep vehicle list synchronized with Asset Management or TMS (Transport Management System). | JSON/XML |
| Driver | Driver – Create, Read, Delete. Synchronise driver list with HR system or ERP. | JSON/XML |
| Geofences | Geofence – Create, Read, Update, Delete. Synchronise sites of interest such as job sites with TMS. | JSON/XML |
| Geofence Entry & Exit | Geofence entry and exit stream. Date and odo stamped events to help monitor vehicle activity into and out of customer, MyEROAD and other geofenced areas of interest. | JSON/XML |
| Message | Send messages to an Ehubo2 and monitor message status (Sent, Received). Supports sending message to a vehicle from TMS. | JSON/XML |
| Partner Gateway | Key value pairs can be sent from a third-party system (e.g., TMS) into MyEROAD for display against the vehicle in the Activity Tracking screen. | JSON/XML |
| Fuel API | Fuel transaction data per vehicle. Fuel providers can submit fuel transactions to the organisation’s MyEROAD in an agreed format. | JSON/XML |
API Integration Workflow
| 1. |
Obtain an API key from Administration > My Organisation in MyEROAD for Authentication. See API Key Setup for instructions. The key restricts customers to the data of organisations linked to the API. The API Key should be mentioned in the header of the request.
|
|
| 2. |
View, interact, and export clients to work with our APIs on SwaggerHub. |
|
| 3. |
Review the EROAD use cases to view and plan the data you can extract from the API. |
|
|
EROAD API base paths: New Zealand: https://api.apac.eroad.com/v1 |
|
|
Contact EROAD for API Assistance
If you need assistance with the REST API, please email support@eroad.com to connect with our dedicated support team.