Einheitliche Zugriffsschnittstelle

Universelle REST-API

Das System stellt eine universelle REST-API bereit, die eine konsistente Interaktion zwischen verschiedenen Systemen, Anwendungen und Geräten ermöglicht. Sie abstrahiert von den Implementierungsdetails und bietet einen standardisierten Weg zum Zugriff auf die Daten und Funktionen des Systems.

Der REST-API-Dienst weist bei der Datenverarbeitung die folgenden Eigenschaften auf:

• Einheitlichkeit: Alle Anfragen und Antworten folgen demselben Format.
• Skalierbarkeit: Unterstützt eine große Anzahl von Geräten und Benutzern.
• Sicherheit: Bietet Authentifizierung, Autorisierung und Datenverschlüsselung.
• Dokumentation: Verfügt über eine verständliche Dokumentation für Entwickler.

Der Dienst vereinfacht die weitere Arbeit mit Daten erheblich:

• Vereinfachte Integration: Verschiedene Systeme und Geräte können über eine einzige Schnittstelle zusammenwirken.
• Hardwareabstraktion: Anwendungen sind nicht von bestimmten Geräten oder Protokollen abhängig.
• Zentrale Verwaltung: Alle Datenanfragen laufen über einen einzigen Einstiegspunkt.
• Flexibilität: Neue Funktionen lassen sich problemlos hinzufügen und bestehende anpassen.

Beispiel einer universellen REST-API-Anfrage

Datenanfrage:

GET /api/v1/channel_data?equipment_id=1&archive_type=daily&channel_id=3

Antwort:

[
  {
    "id": 123,
    "equipment_id": 1,
    "seance_id": 2,
    "channel_id": 3,
    "archive_type_id": 4,
    "value": 42.5,
    "event_time": 1739950861
  }
]

Vorteile der universellen REST-API

Der REST-API-Dienst ist ein leistungsfähiges Werkzeug, das eine einheitliche Datenzugriffsschnittstelle schafft.

Er ermöglicht Ihnen:

• Von konkreten Geräten und Technologien zu abstrahieren.
• Konsistenz und einfache Bedienung sicherzustellen.
• Die Integration neuer Systeme und Geräte zu vereinfachen.

Abfragesprache

Aufbauend auf dieser einheitlichen Datenzugriffsschnittstelle nutzt das System eine Abfragesprache, damit Benutzer und Anwendungen mit der Datenbank interagieren können, um Informationen abzurufen, zu ändern oder zu verwalten. Eine universelle Abfragesprache sorgt für Konsistenz, einfache Bedienung und leistungsstarke Möglichkeiten zur Datenmanipulation.

Die Abfragesprache bietet die folgenden Möglichkeiten:

• Vereinfachte Datenmanipulation: Benutzer können Daten abrufen, ohne komplexen Code schreiben zu müssen.
• Standardisierung: Eine einheitliche Sprache für alle Datenoperationen.
• Flexibilität: Die Möglichkeit, sowohl einfache als auch komplexe Abfragen auszuführen.
• Integration: Lässt sich problemlos in verschiedene Systeme und Anwendungen integrieren.

Beispiele für im System verwendete Abfragesprachen

SQL (Structured Query Language)

Das DBMS PostgreSQL verwendet zur Arbeit mit Daten die Abfragesprache SQL. Sie unterstützt die grundlegenden Operationen zur Datenmanipulation.

Beispiel einer SQL-Abfrage zum Abrufen von Daten:

SELECT id, channel_id, value
FROM channel_data
WHERE equipment_id = 1 AND archive_type_id = 4;

REST-Schnittstelle mit Parametern

Die universelle REST-API implementiert im Rahmen ihrer Dateninteraktion eine REST-Schnittstelle mit Parametern. Dadurch kann die API Abfrageparameter zum Filtern von Daten verwenden.

Zum Beispiel:

GET /api/v1/channel_data?equipment_id=1&channel_id=101

Active Record Query Interface

Das Framework Ruby on Rails implementiert Active Record (das Active Record Query Interface), mit dem Sie Datenbanken abfragen können, ohne SQL zu verwenden.

Hier ist ein Beispiel für eine Active Record-Abfrage zum Abrufen von Daten:

ChannelDatum.where(equipment_id: 1, archive_type_id: 4)