Overview

Architecture overview

The design approach provides an open, standards-based interface using the REST architecture and provides an easy and intuitive way of communication with EROAD via the HTTP protocol.

GETPOSTPUT, and DELETE requests are used to the API endpoints.

OData Dictionary (PDF)

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.

The remaining sections explain:

  • How to test the API?
  • Common use cases
  • Usage and policies
  • Host details
  • How to set up an API Key?
  • FAQs
  • Help