...

Project/Product

...

ELPRO CLOUD

...

Issue

...

Basic REST API for elproCLOUD

...

Version

...

1.0.0

1. Table of Contents

...

...

2. General

2.

...

3. Communication Concept elproCLOUD <> external Application

• REST-API for requesting data

...

4. Version of the REST-API

...

5. General for all Requests

• 5.1 Security Scheme Type

• 5.2 User Scope

• 5.3 Http Error Codes

• 5.4 Request and Response Schema

...

6 Devices

...

7 Sensors

...

8 Public Endpoints and Technical Specification

...

1 Devices

Representation of devices are identified by their unique serial numbers. These data objects carry a subset of information, as well as a list of SensorIds for data sinks, which contain measurement data. With the given API key, the user and the linked devices are identified.

2.2 Sensors

Sensors represent a data sink holding the data of a run. Each sensor has a start and end date. Its sensor id is unique and links to measurements, geolocation and occurrence data.

Once the Device is restarted, a new sensor data sink will be created with a new id.

2.3 Wording

...

Physical device

A physical device is identified by a serial number and has 1 to n channels.
Each channel can be configured independently (e.g. own measurement interval) and has one or more sensors, which can provide 1 to m different sensor values.
For example;

• one value: temperature (for a Temperature-Sensor)

• two-tuples of: relative humidity and temperature (for a rH-sensor)

• three-tuples of: status, #changes, relative on (for a DI-sensor)

Virtual representation with alarming

In elproCLOUD we have a one to one mapping of device and channel.
For the values of a sensor we have an one to n mapping to virtual sensors.

A virtual sensor is created for every configuration of a real sensor and is used to attach different type of alarms to the same sensor value.

3. Communication Concept elproCLOUD <> external Application

...

REST-API for requesting data

The communication between the elproCLOUD and the external application is realized via a REST-API 1<=2 and 4=>3. The interface 1<=2 is used to request information by external application from the elproCLOUD. The interface 4=>3 will provide information that was requested by the external application.

The communication runs typically in the following sequence:

...

2.4 Data format

Note that any JSON accepted and returned by the API must follow the JSON standard as defined in the ECMA-404 standard with the following amendments.

1. JSON property names are case invariant and no guarantee can be made regarding the casing of names, which are returned by the API. This means that no difference is made between uppercase and lowercase letters in property names.

2. The relative order of JSON names in responses is not be guaranteed. This means that the order of properties in the responses should not be depended on, when parsing and processing responses.

...

3. REST-API

...

The client can request information from elproCLOUD via REST-API. The communication runs typically in the following sequence:

The device will send its data and occurences in defined fix

...

inteval to the elproCLOUD.
There are

...

mechanisms, where the device will send its data directly to the elproCLOUD and will not wait for the next communication interval.

The customer app requests the data from elproCLOUD via the REST-API on demand or in a self defined intervall. This interval should be defined based on a risk-assesment.

...

4. Version of the REST-API

For the REST-API a versioning mechanism is implemented.

The versioning includes a Major and a Minor number.

Major numbers will provide an interface to the elproCLOUD and will be increased, if the functionality of the interface is dramatically changed. Minor numbers will be increased, if information is added to the returned data structure. 

Major REST-API Versions will be still available via the URL.

• elprocloud_request_url/api/v1/…    (for v1 of the REST-API)

• elprocloud_request_url/api/v2/…    (for v2 of the REST-API)

 Major.Minor Versioning will be included in the returned json response.

{

"version": "<Major.Minor>",

}

5. General for all Requests

...

Specification:

• The Endpoint REST API URL https://apibridge.elpro.cloud

  • The API token is provided by ELPRO

• For Developers the OpenAPI technical specification as Swagger UI https://apibridge.elpro.cloud/swagger

3.1 Data sets and general request scheme

The client can request different data sets, including

• Measurements

• Geodata

• Occurences

• Deviation

3.1.1 Security Scheme Type

Initially, ELPRO sets up an API key for a dedicated user of an organization.

Provide your API authorization code in the Request Header as Key and Value: 

In case of lack or mismatch, an Error message with HTTP Status 401 “Unauthorized” will be returned.

...

3.1.2 User Scope

Retrieved data is in the scope of the organization of the authenticated API User. It will be returned with HTTP-Statuscode 200 (Success).

...

3.1.3 Http Error Codes

...

5.4 Request and Response Schema

Note that any JSON accepted and returned by the API must follow the JSON standard as defined in the ECMA-404 standard with the following amendments.

1. JSON property names are case invariant and no guarantee can be made regarding the casing of names, which are returned by the API. This means that no difference is made between uppercase and lowercase letters in property names.

2. The relative order of JSON names in responses is not be guaranteed. This means that the order of properties in the responses should not be depended on, when parsing and processing responses.

6 Devices

Representation of devices are identified by their unique serial numbers. These data objects carry a subset of information, as well as a list of SensorIds for data sinks, which contain measurement data. With the given API key, the user and the linked devices are identified.

7 Sensors

Sensors represent a data sink holding the data of a run. Each sensor has a start and end date. Its sensor id is unique and links to measurements, geolocation and occurrence data.

Once the Device is restarted, a new sensor data sink will be created with a new id.

8 Public Endpoints and Technical Specification

...

3.2 Version of the REST-API

For the REST-API a versioning mechanism is implemented.

The versioning includes a Major and a Minor number.

Major numbers will provide an interface to the elproCLOUD and will be increased, if the functionality of the interface is dramatically changed. Minor numbers will be increased, if information is added to the returned data structure. 

Major REST-API Versions will be still available via the URL.

• elprocloud_request_url/api/v1/…    (for v1 of the REST-API)

• elprocloud_request_url/api/v2/…    (for v2 of the REST-API)

 Major.Minor Versioning will be included in the returned JSON response.

{

"version": "<Major.Minor>",

}

...

4. Message Queue (AMQP)

...

• A “Customer-Queue” is provided using AMQ protocol which is reachable under amqp.elpro.cloud.

• The Queue-Name is the name of the explicitly provisioned RabbitMQ Queue. Queue and Users are managed by ELPRO.

• Furthermore a unique username and password for every customer is provided. See below in this document for an example implementation.

•  Every customer can use his AMQP client of choice to read and acknowledge on the list of message types.

• The connection is TLS only (Port 443)

• In Production the Time to live (TTL) of queue data is set to three days.

4.1 Message Models

The Queue Messages will have following basic payload as JSON:

4.2 Message Type

Each Type represents a dedicated json payload inside the Data JSON object. So a consumer knows which Data Model is used.

• eapi_measurement_new

• eapi_geodata_new

• eapi_occurrence_new

• eapi_deviation_enter

• eapi_deviation_leave

4.3 Data Models

The Data payloads are different for each type.

4.3.1 Measurement

4.3.1.1 Example Measurements

Data with type: “eapi_measurement_new”

{
    "type": "eapi_measurement_new",
    "data": {
        "timeStamp": "2022-10-11T16:21:27+00:00",
        "value": 24.6,
        "unit": "°C",
        "unitType": “temperature",
        "deviceId": "951FF00000340",
        "sensorId": "5368"  
    }
}

4.3.2 GeoData

4.3.2.1 Example GeoData

Data with type: “eapi_geodata_new” 

{
    "type": "eapi_geodata_new",
    "data": {
        "timeStamp": "2022-10-11T15:21:24+00:00",
        "latitude": 47.19999075,
        "longitude": 9.50875282,
        "accuracy": 2316,
        "deviceId": "951FF00000340",
        "sensorId": "5369"
    }
}

4.3.3 Occurrence

4.3.3.1 Example Occurence

Data with type “eapi_occurrence_new” 

{
    "type": "eapi_occurrence_new",
    "data": {
        "timeStamp": "2022-10-11T15:21:24+00:00",
        "typeName": "LoggerStatusChange",
        "previousState": "Start",
        "newState": "LogDelayed",
        "deviceId": "951FF00000340",
        "sensorId": "5369"
    }
}

4.3.4 Deviation

4.3.4.1 Example Deviation Enter

Data with type “eapi_deviation_enter” 

{
    "type": "eapi_deviation_enter",
    "data": {
        "deviceId": "951FF00000340",
        "sensorId": 5763,
        "timeStamp": "2022-10-26T17:00:22+00:00",
        "historyType": "enter",
        "deviationType": "limit",
        "reason": "upper_limit_alarm"
    }
}

4.3.4.2 Example Devation Leave

Data with type “eapi_deviation_leave”

{
    "type": "eapi_deviation_leave",
    "data": {
        "deviceId": "951FF00000340",
        "sensorId": 5763,
        "timeStamp": "2022-10-26T18:00:22+00:00",
        "historyType": "leave",
        "deviationType": "limit",
        "reason": "upper_limit_alarm"
    }
}

4.4 Consume AMQP Messages

4.4.1 Example Client Code with RabbitMQ in C#

 Example Code how to connect to a Queue with .NET and RabbitMQ nuget library:

public ObservableCollection<MessageModel> Messages { get; private set; }

public static IConnection connection;
public static IModel channel;
public static EventingBasicConsumer consumer;

public void Read()
{        
    var serverName = "amqp.elpro.cloud"
    var queueName = "398ab9ae90efce88dcf623cc49e302e1";
    bool autoACK = true;

    try
    {
        // Prepare 
        var factory = new ConnectionFactory()
        {
            HostName = serverName,
            UserName = "user",
            Password = "password",
            Port = 443,
            Ssl = new SslOption() 
            { 
              Enabled = true, 
              ServerName = serverName
            }
        };

        connection = factory.CreateConnection();
        channel = connection.CreateModel();
      
        var routingKey = $"*.eapi_*"; //*.eapi_measurement_new e.g.                        
        Console.WriteLine(" [*] Waiting for msgs.");

        // Consumer
        consumer = new EventingBasicConsumer(channel);
        consumer.Received += (model, ea) =>
        {
            var body = ea.Body.ToArray();
            var messageText = Encoding.UTF8.GetString(body);

            var message = new MessageModel(ea.RoutingKey, messageText);

            Dispatcher.Dispatch(() => Messages.Add(message));
        };

        // Subscribe
        channel.BasicConsume(queue: queueName,
                    autoAck: autoACK,
                    consumer: consumer);

    }
    catch (Exception ex)
    {
        Console.WriteLine($"Error at RabbitMQ.Test: {ex.Message}");
    }
}

...

5. Connection Details and Technical Specification

• Endpoint REST API URL https://apibridge.elpro.cloud

• AMQP Server: amqp.elpro.cloud

• For Developers the OpenAPI technical specification as Swagger UI https://apibridge.elpro.cloud/swagger