API Developer Resources

EROAD APIs enable you to integrate valuble 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 GETPOSTPUT, and DELETE requests to access the API endpoints. 

Additional fees may apply to use of the EROAD APIs.

     Developers Our simplified API workflow makes it easy for you to get started integrating with EROAD.  Go to the EROAD Partner Gateway to integrate vehicle-specific data into the EROAD system.

    Partners

The Fuel API enables you to import third party fuel purchase transaction data to support fuel reporting with EROAD vehicle location and distance data.

 API Integration Workflow

1.

Contact EROAD to optain our Specification (EROAD API JSON file).

EROAD uses the open framework, swagger.io, to document the Specification. Swagger is an open API initiative and is one framework option for describing our API using a common language that everyone can understand. There are other frameworks such as RAML, APIBlueprint and Summation. 

We find the Swagger editor is a powerful and easy tool to use for viewing the API. You can use it to test the operations, get full descriptions of the parameters, and generate an example.

 
2.

Obtain an API key from Administration > My Organization in Depot for Authentication. See API Key Setup

The key restricts customers to the data of organizations linked to the API. The API Key should be mentioned in the header of the request. 

3.

Call the REST API directly or contact EROAD to obtain an API client to use for integration purposes.

 
4.

Enter your APIkey and the hostname into the BASE PATH that is applicable to your country.

New Zealand:          https://api.apac.eroad.com
North America:        https://api.na.eroad.com
Australia:                 https://api.au.eroad.com

 EXAMPLE:

"security": [{"api_key": [Enter APIkey]}],
"consumes": ["application/json","application/xml"],
"produces": ["application/json","application/xml"],
"schemes": ["https"],
"basePath": "/Enter Hostnamev1", 

5.  Review the EROAD use cases to view and plan the data you can extract from the API.   

 

EROAD for API Assistance

If you need assistance with the REST API, please email support@eroad.com to connect with our dedicated support team.