Introduction

About

The autoX REST API enables you to interact with your automotive DMS data programmatically. Use this API to build integrations, automate dealer operations, or develop custom applications on top of your autoX instance. This page documents the REST resources available in autoX, including HTTP response codes and example requests and responses.

The autoX REST API is built on the Open Data Protocol (OData), exposed via SAP S/4HANA's OData services layer. All resources are addressed as HTTP endpoints following OData conventions for querying, inserting, updating, and deleting data.

Base URL

The base URL of the autoX API is the same as your SAP S/4HANA instance URL. The service root follows this structure:

https://<your-sap-instance>/sap/opu/odata/sap/<service_name>/

If you are unsure of your SAP instance URL, refer to the SAP Community guide on locating your system URL.

To discover all available entity sets for a given service, append $metadata to the service root:

GET https://<your-sap-instance>/sap/opu/odata/sap/<service_name>/$metadata

Authentication

The autoX API uses HTTP Basic Authentication. Include an Authorization header with your SAP credentials encoded in Base64 on every request.

Authorization: Basic

Example using cURL:

curl -X GET \
"https://<your-sap-instance>/sap/opu/odata/sap/<service_name>/<entity_set>" \
-H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=" \
-H "Accept: application/json"

Keep credentials secure. Never expose your SAP username or password in client-side code or public repositories. Use environment variables or a secrets manager instead.

Authorization

Authorization is role-based and managed within SAP. Users must be assigned the appropriate SAP roles for the modules they need to access. Contact your SAP system administrator to manage role assignments.

About#

Base URL#

Authentication#

Authorization#

About

Base URL

Authentication

Authorization