EROAD Help New Zealand

0800 437 623 7am-7pm, Mon-Fri

API Key Setup

Framework

We have used the open framework swagger.io to document our specification and we’ve found the swagger editor tool really powerful to view the API.

JSON / XML

  • Accepts ApiKey
  • Accepts application in XML and JSON format

The JSON contains the documentation and error handling for the following endpoints.

  • Current Location
  • Fleet
  • Vehicle
  • Geofence

EROAD JSON - please contact us to get access

Step by Step guide

  1. Head to http://editor.swagger.io/.

  2. Import the EROAD API JSON file to view the structure and definitions.

    swagger 1

    swagger 2

 

Authentication

All operations require an API key for full access. API Key can be set up by the customer, find info here. The key will restrict customers to the data of the organisations linked to the API.