API Access für den nahtlosen Austausch von READy-Daten mit anderen Systemen

Was ist API Access?

API Access von Kamstrup ermöglicht READy den sicheren Datenaustausch mit anderen Systemen, wie Kundenportalen, GIS oder SCADA. Auf diese Weise kann ein digitales Ökosystem geschaffen werden, das das Teilen von Informationen aus verschiedenen Systemen ermöglicht – so können Sie sowohl die Qualität Ihres Kundenservices verbessern als auch bestehende Betriebs- und Arbeitsabläufe optimieren.

API Access ist ein Add-on für READy, das sich gerade an diejenigen richtet, die Daten einfach und sicher zwischen ihren Systemen übertragen wollen. API Access steht den Kunden des von Kamstrup gehosteten READy-Systems zur Verfügung. Für lokale READy-Installationen kann es allerdings nicht genutzt werden. Die bereits bekannten READy-Funktionen bleiben Ihnen auch weiterhin erhalten – gleichzeitig sorgt API Access für eine flüssigere Bereitstellung von Informationen und eine integrierte Benutzererfahrung bei der Verwendung von READy.

Kamstrup bietet Versorgungsunternehmen und Drittentwicklern die Möglichkeit, Anfragen auf sicherem Wege über API Access zu entwickeln und zu testen: Dazu stellen wir eine Testumgebung bereit, die wir auch als Sandkasten bezeichnen. Dank dieser Option kann sichergestellt werden, dass Integration und Anwendung auf soliden Beinen stehen, bevor sie in die Produktion gelangen.

Was ist eine API?

Bei einer API (Application Programming Interface oder Programmierschnittstelle) handelt es sich um einen Code, der als Schnittstelle zwischen unterschiedlichen, oftmals von verschiedenen Lieferanten stammenden Systemen fungiert – dadurch wird die Kommunikation und der Datenaustausch zwischen zwei oder mehr Systemen unabhängig von den ihnen zugrundeliegenden Architekturen oder Technologien ermöglicht.

API Access und die Exportfunktion von READy im Vergleich: Wo liegt der Unterschied?

Im Folgenden haben wir die Hauptunterschiede zwischen den Funktionen von API Access und der READy-Exportfunktion für den direkten Vergleich gegenübergestellt. Wenn Sie API Access von Kamstrup integrieren, steht Ihnen die Exportfunktion von READy auch weiterhin zur Verfügung – es kommen lediglich weitere Optionen hinzu, die eine effizientere Datenübertragung und größere Kontrolle über die Zählerdaten gewährleisten.

READy-Exportfunktion

READy API Access

Regelbasierter Datenexport

Sobald die Exportfunktion in Ihrem READy Manager integriert ist, müssen Sie sich nur noch entscheiden, ob Ihre Daten stündlich, täglich, wöchentlich oder monatlich exportiert werden sollen. Der Export erfolgt dann nach einem festgelegten Zeitplan, wobei er mindestens einmal in der Stunde stattfindet.

Ereignisbasierter Datenexport

Mit dem API Access-Add-On für den READy Manager können Sie auch einstellen, welche Daten beim Eintreten bestimmter Ereignisse automatisch übertragen werden sollen oder wenn sie in READy bereitstehen, anstatt einem festen Export-Zeitplan zu folgen.

Verzögerte Alarme

Auch wenn Alarme (Infocodes) kurz nach ihrer Auslösung im physischen Zähler in READy bereitstehen, müssen Sie diese entweder manuell in READy abrufen oder auf den nächsten Export der Alarme laut Zeitplan warten.

Rechtzeitige Alarme

Wenn API Access im READy Manager integriert ist, können Sie die Alarme (Infocodes) abonnieren. Das bedeutet, dass Sie benachrichtigt werden, sobald ein Alarm in READy ausgelöst wird; die entsprechenden Informationen erhalten Sie dann über API Access.

Unidirektionaler Datenexport

Die READy-Exportfunktion dient nur einem einzigen Zweck: der Extraktion von Daten aus READy, die dann außerhalb des READy Managers zur Verfügung gestellt werden. Der Import von Informationen ist mit der READy-Exportfunktion nicht möglich.

Bidirektionale Datensynchronisierung

API Access überträgt Daten aus READy in andere Systeme, aber es ermöglicht anderen Systemen auch, Änderungen an Gruppen, Installationspunkten und Zählern an READy zurückzuschicken.

Standard-Datenschutz

Die über die eingebaute Exportfunktion des READy Managers exportierten Daten werden an einen SFTP- oder FTP-Server oder eine E-Mailadresse weitergeleitet. Diese Zieladressen sind in der Regel mit einem Benutzernamen und einem Passwort geschützt.

Erweiterter Datenschutz

Um Daten über API Access übertragen zu können, brauchen Sie ein gültiges OAuth2-Zugriffstoken, für das drei Eingaben erforderlich sind: eine Client-ID, eine Parteien-ID und ein geheimer Client-Schlüssel (Client Secret). Darüber hinaus sind die Daten verschlüsselt. Wenn Sie die Webhooks-/Abonnement-Funktion von API Access verwenden möchten, ist auch ein aktiver API-Schlüssel des READy Managers erforderlich.

API Access für Entwickler: Wie funktioniert API Access?

Bei API Access von Kamstrup handelt es sich um einen Code, der die Anschlusspunkte des READy-Servers steuert. Das funktioniert auf zwei unterschiedliche Arten: zum einen als Standard-REST API (Representational State Transfer), ein Web-Service, der einem Client unter Verwendung eines Hypertext-Übertragungsprotokolls (HTTP) ermöglicht, über URL-Pfade Ressourcen aus READy anzufordern. Dieser Vorgang ist mit dem Besuch einer regulären Website vergleichbar, auf der Sie eine auf einem Server gespeicherte Ressource anfordern und der Server mit der gewünschten Information antwortet.

Klicken Sie auf „Mehr erfahren“ weiter unten, um weitere Informationen über API Access zu erhalten.

Mehr erfahren

Schließen

Neben dem regulären Anfrage-Antwort-Verfahren kann API Access von Kamstrup auch als Webhook-API eingesetzt werden. Bei den Standard-REST APIs werden Daten reaktiv behandelt und auf Anfrage bereitgestellt: Das bedeutet, dass lediglich auf Anfragen reagiert wird, aber ohne Aufforderung des Nutzers keine Aktivitäten erfolgen. Auf der anderen Seite kann ein Webhook Anfragen (beispielsweise Anfragen zum Abruf aller Zähler) und Ereignisse (beispielsweise das Abonnement der jüngsten Zählerauslesungen) bearbeiten. Ein ereignisgesteuertes Verfahren besagt, dass ein System nur dann Daten senden darf, wenn ein bestimmtes Ereignis eintritt. Sowohl die Webhook- als auch die REST API antworten in JSON.

Aus technischer Sicht ermöglicht API Access Entwicklern bei gleichzeitiger Gewährleistung der Datensicherheit die Automatisierung, Erweiterung und Kombination von Daten aus Geräten wie Zählern oder anderen Systemen oder Diensten. In der Praxis versetzt dies Entwickler in die Lage, ein digitales Ökosystem ins Leben zu rufen, programmatisch Apps und Dienste zu entwickeln sowie weitere Aufgaben auszuführen, für die bisher immer die Software-Suite von Kamstrup erforderlich war.

Die automatische Integration von READy in Ihr IT-System erfordert eigene Software-Entwicklungskapazitäten, denn diese sind nicht im Lieferumfang von API Access enthalten.

Kamstrup bietet außerdem das Produkt „API Access – Entwicklungsumgebung“ an, eine Art API-Sandkasten, der Testzwecken dient. Diese Testumgebung gibt Programmierern und Entwicklern die Möglichkeit, Änderungen auszuprobieren, ohne dabei in die Live-Umgebung einzugreifen. Darüber hinaus ermöglicht sie auch Drittentwicklern die Generierung von Lösungen und Diensten. Der API-Sandkasten enthält Testdaten von ca. 5.000 Zählern, sodass Entwickler neue Codes testen, Situationen aus der Praxis simulieren und simulierte Antworten generieren können. Dabei handelt es sich um ein separates Produkt von API Access, das sich an Versorgungsunternehmen und Drittentwickler richtet. Auf diese Weise können potenzielle Bugs noch vor der Implementierung abgefangen werden, was sowohl die mit neuen Versionen verbundenen Kosten als auch ihre Risiken herabsetzt.

Haben Sie die Software bereits erworben und möchten nun beginnen, Daten aus READy über API Access abzurufen?