Skip to main content

Interfaces

The platform consists of a set of interfaces related to the platform APIs and communication with Connector.

These interfaces must be generally applied when extending the platform, in case you would like to develop custom Connector providing some specific functionality or implementing some proprietary protocols.

The platform consists of the following interfaces:

  • Client Web Interfaces
  • Client REST API
  • Connector Interfaces
  • Core Interfaces

To know more about the list of APIs refer to Interfaces Repository.

Client Web Interfaces

Client web interfaces are graphical representation for the user in form of web applications. Currently, there are the following Client web interfaces:

InterfaceDescription
AdministratorManagement of the platform and all resources and their operations. This interface also includes administrative components and administrative operations.
Operator(Deprecated) Provides certificate and cryptographic key related operations.

Client REST API

Platform offers REST API to communicate with the platform. REST API can be split into two major categories:

InterfaceDescription
AdministrationFor administrative operations.
Client OperationsFor certificate and cryptographic key related operations.

Connector Interfaces

The Connector interface implements specific technology that can be connected with the platform. Depending on the technology and use-case, the Connector may be of different Types and Functional Groups.

Each Connector has to implement at least the following interfaces:

  • Attributes
  • Health
  • Info

Core Interfaces

Core interfaces are used by the platform to communicate with the Connector and the Client.

You can find the description of the Core interfaces in the following sections: