Skip to content

Nerve API documentation

Open API documentation provides a standardized and human-readable interface to the Nerve API. This document outlines the available Nerve API endpoints, their functionalities, and usage guidelines, enabling seamless integration and utilization of Nerve's capabilities.

The first chapter introduces the Nerve Management System API, followed by the Nerve Node API.

Nerve Management System API

The Nerve Management System API documentation is written according to the OpenAPI 3 standard and can be viewed in the Swagger UI below.

Note that some parts of the Nerve Management System API are still in migration to the OpenAPI standard. This means that not all functions are available in OpenAPI. Missing functions are gradually added to the OpenAPI standard and will be documented as soon as they are ready.

In the meantime, refer to the Legacy API documentation below for more information on how to work with the legacy implementation using a python-based API wrapper.

Note

The API documentation file uses trynerve1.nerve.cloud as the Management System. Other Management Systems will not allow the use of the "Try it out"-feature of the web-based Swagger Editor, as cross-origin resource sharing is deactivated for security reasons. Therefore, in order to try out the API from within the Swagger Editor, request a free trial for access to trynerve1.nerve.cloud or contact support through the TTTech Industrial support portal.

In order to use the "Try it out"-feature from the Swagger Editor on other Management Systems, contact support through the TTTech Industrial support portal, as Nerve service technicians need to configure the Management System first.

Note

  • The serial number needs to be entered in all capital letters for all functions requiring a serial number input.
  • For pointers on how to work with the Management System API, e.g. how to create client source code, refer to Working with the Management System API.

Nerve Node API

The Node API documentation is written according to the OpenAPI 3 standard and can be viewed in the Swagger UI below.

Note that some parts of the Node API are still in migration to the OpenAPI standard. This means that not all functions are available in OpenAPI. Missing functions are gradually added to the OpenAPI standard and will be documented as soon as they are ready.

Legacy API documentation

Functions that have not yet been migrated to the OpenAPI standard are available/can be used with a python-based API wrapper. Download the Nerve_API_2.8.0.zip from the Nerve Software Center. The login credentials for the download can be found in the customer profile.

For more information, write an issue through the TTTech Industrial support portal.