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 GET, POST, PUT, and DELETE requests to access the API endpoints. Additional fees may apply to use the EROAD APIs.
Integrating with EROAD Workflow
| 1. | Contact EROAD to obtain the Specification and begin your development. |
We use the open framework swagger.io to document our Specification and find the Swagger editor is a powerful tool to view the API. 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. The Swagger editor is an easy to use tool for reading the EROAD API JSON (Specification). 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 the organizations linked to the API. The API Key should be mentioned in the header of the request. |
||||||
| 3. | You can call the REST API directly or contact EROAD to obtain an API client to use for integration purposes. | You must use the hostname that is applicable to your country to access the API:
|
||||||
| 4. | Review the EROAD use cases to view and plan the data you can extract from the API. |
Usage / Policies
| Usage policy | Rating limit may apply outside the usage policy or if the service is degraded. |
| Polling frequency | Clients must not poll more frequently than 60 seconds. |
| Latency | Current location can be delayed from the vehicle due to cellular network coverage. |
| Retry timeout | The client should timeout a request at 30 seconds. A retry delay, of at least 2 minutes, should be used on timeout or 503 response code to not unnecessarily load the system. |
| Transport | EROAD will provide an HTTPS REST service endpoint using SSL. This will provide a 128bit encrypted link. |
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.