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?
5 gute Gründe, um API Access noch heute in READy zu integrieren
Entdecken Sie die Vorteile von API Access. Die Integration dieser Software-Lösung in READy verschafft Ihnen neue Funktionen und Vorteile, ohne dass Sie auf die bereits bekannten Funktionen von READy verzichten müssen.
1. Automatisierter Zugang zu READy-Daten
2. Reduzierung manueller Abläufe
3. Immer auf dem neuesten Stand
4. Garantierte Datensicherheit
5. Einfacher Einstieg mit REST API
API Access und die Exportfunktion von READy im Vergleich: Wo liegt der Unterschied?
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
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?
Haben Sie noch weitere Fragen zu API Access?
Werfen Sie einen Blick in unsere häufigen Fragen (FAQ).
Was ist API Access? Hier kommt die (kurze) technische Erklärung.
Gibt es Beispiele für die Verwendung von API Access bei anderen Versorgungsunternehmen?
Unterschiedliche Versorgungsunternehmen nutzen API Access für verschiedene Dinge. Zu den wichtigsten Anwendungsfällen gehören allerdings die folgenden:
- Nutzung von API Access zum Aufbau eines unternehmenseigenen Datawarehouses zur Schaffung der bestmöglichen Datengrundlage
- Nutzung von API Access zur Integration von READy in das Abrechnungssystem zur Gewährleistung von Abrechnungskonformität
- Nutzung von API Access, um die Verwendung der Zähleraustausch-Tools Dritter zu ermöglichen und Zähleraustausch-Vorgänge automatisch in READy zu aktualisieren
- Nutzung von API Access zur Integration von Daten in Kundenportale oder Verbraucheranwendungen, sodass diese automatisch mit den neuesten Informationen aktualisiert werden
Welche Vorteile hat API Access insgesamt?
Die Nutzung von API Access hat mehrere Vorteile. Die bedeutendsten davon sind:
- Herstellung der Interoperabilität von READy mit anderen Systemen
- Automatisierung manueller Abläufe
- Rückgriff auf die neuesten Daten und Alarme
- Übertragung von Änderungen in einem System auf READy
- Sicherere Datenübertragung zwischen Systemen
- Schneller Einstieg für Software-Entwickler
Was ist der Unterschied zwischen einer REST-Anfrage und einem Webhook?
Ist API Access sicher?
Wie werden sensible Daten in API Access verwaltet?
Wie kann ich einfach in die Verwendung von API Access einsteigen?
Bei API Access handelt es sich um ein Add-on zum READy Manager. Ihr Vertriebsmitarbeiter bei Kamstrup unterstützt Sie gern bei den ersten Schritten und kann einen Zugang für Sie freischalten lassen. Bevor Sie mit der Erstellung Ihrer eigenen Lösungen mit API Access beginnen, würden wir Ihnen die Lektüre unserer Schritt-für-Schritt-Anleitung „Einfacher Einstieg in API Access“ sowie der folgenden Online-Dokumentation empfehlen: EU & US.
Welche Voraussetzungen müssen zur Verwendung von API Access erfüllt sein?
Ihr Einstieg in die Verwendung von API Access erfolgt in vier einfachen Schritten: (1) Sie müssen ein Kunde des von Kamstrup gehosteten READy-Systems sein; (2) Sie benötigen eine aktive E-Mailadresse und Telefonnummer; (3) zur Verwendung von Webhooks brauchen Sie einen aktiven Server und (4) Sie brauchen unternehmenseigene Software-Entwicklungskapazitäten oder müssen sich einen entsprechenden Partner suchen, da Kamstrup keine Beratungsleistungen im Zusammenhang mit der API anbietet.
Weitere Informationen finden Sie im Datenblatt READy – API Access”.
Wie kann API Access zur Straffung interner Arbeitsabläufe beitragen?
Kann ich meine einmal entwickelte Lösung auch an nicht zur Produktion gehörigen Daten testen?
Ist der neue API Access-Sandkasten „API Access – Entwicklungsumgebung“ in meinem Abonnement von API Access oder READy inkludiert?
Kann ich eine Testversion von API Access ausprobieren, bevor ich mich für einen Kauf des Systems entscheide?
Kann ich neue Funktionen oder kommende Versionen von READy API Access testen, bevor sie erscheinen?
Was sind die nächsten Schritte, nachdem ich API Access bestellt habe?
Ist das Client Secret dasselbe wie der Schlüssel im READy Manager?
Muss ich nach dem Kauf von API Access eine Lizenz aktivieren wie bei anderen Software-Produkten von Kamstrup?
Was bedeutet es, wenn einer der Infocode-Endpunkte eine Liste mit Zeichenfolgen ausgibt?
Neben intelligenten Zählern von Kamstrup umfasst mein Verteilnetz auch Drucksensoren von Kamstrup. Können die entsprechenden Daten über API Access übertragen werden?
In der Dokumentation des API Access Swaggers enthalten einige Endpunkte /v1/, andere wiederum /v2/. Ist eine Version der anderen vorzuziehen?
Welche Endpunkte muss ich bei meiner Authentifizierung verwenden?
Wenn Sie sich schon einmal gefragt haben, welchen Authentifizierungs-Endpunkt Sie verwenden sollen – hier ist der richtige: https://signon.kamstrup.com/token.
Was ist API Access? Hier kommt die (kurze) technische Erklärung.
Gibt es Beispiele für die Verwendung von API Access bei anderen Versorgungsunternehmen?
Unterschiedliche Versorgungsunternehmen nutzen API Access für verschiedene Dinge. Zu den wichtigsten Anwendungsfällen gehören allerdings die folgenden:
- Nutzung von API Access zum Aufbau eines unternehmenseigenen Datawarehouses zur Schaffung der bestmöglichen Datengrundlage
- Nutzung von API Access zur Integration von READy in das Abrechnungssystem zur Gewährleistung von Abrechnungskonformität
- Nutzung von API Access, um die Verwendung der Zähleraustausch-Tools Dritter zu ermöglichen und Zähleraustausch-Vorgänge automatisch in READy zu aktualisieren
- Nutzung von API Access zur Integration von Daten in Kundenportale oder Verbraucheranwendungen, sodass diese automatisch mit den neuesten Informationen aktualisiert werden
Welche Vorteile hat API Access insgesamt?
Die Nutzung von API Access hat mehrere Vorteile. Die bedeutendsten davon sind:
- Herstellung der Interoperabilität von READy mit anderen Systemen
- Automatisierung manueller Abläufe
- Rückgriff auf die neuesten Daten und Alarme
- Übertragung von Änderungen in einem System auf READy
- Sicherere Datenübertragung zwischen Systemen
- Schneller Einstieg für Software-Entwickler
Was ist der Unterschied zwischen einer REST-Anfrage und einem Webhook?
Ist API Access sicher?
Wie werden sensible Daten in API Access verwaltet?
Wie kann ich einfach in die Verwendung von API Access einsteigen?
Bei API Access handelt es sich um ein Add-on zum READy Manager. Ihr Vertriebsmitarbeiter bei Kamstrup unterstützt Sie gern bei den ersten Schritten und kann einen Zugang für Sie freischalten lassen. Bevor Sie mit der Erstellung Ihrer eigenen Lösungen mit API Access beginnen, würden wir Ihnen die Lektüre unserer Schritt-für-Schritt-Anleitung „Einfacher Einstieg in API Access“ sowie der folgenden Online-Dokumentation empfehlen: EU & US.
Welche Voraussetzungen müssen zur Verwendung von API Access erfüllt sein?
Ihr Einstieg in die Verwendung von API Access erfolgt in vier einfachen Schritten: (1) Sie müssen ein Kunde des von Kamstrup gehosteten READy-Systems sein; (2) Sie benötigen eine aktive E-Mailadresse und Telefonnummer; (3) zur Verwendung von Webhooks brauchen Sie einen aktiven Server und (4) Sie brauchen unternehmenseigene Software-Entwicklungskapazitäten oder müssen sich einen entsprechenden Partner suchen, da Kamstrup keine Beratungsleistungen im Zusammenhang mit der API anbietet.
Weitere Informationen finden Sie im Datenblatt „READy – API Access”.
Wie kann API Access zur Straffung interner Arbeitsabläufe beitragen?
Kann ich meine einmal entwickelte Lösung auch an nicht zur Produktion gehörigen Daten testen?
Ist der neue API Access-Sandkasten „API Access – Entwicklungsumgebung“ in meinem Abonnement von API Access oder READy inkludiert?
Kann ich eine Testversion von API Access ausprobieren, bevor ich mich für einen Kauf des Systems entscheide?
Kann ich neue Funktionen oder kommende Versionen von READy API Access testen, bevor sie erscheinen?
Was sind die nächsten Schritte, nachdem ich API Access bestellt habe?
Ist das Client Secret dasselbe wie der Schlüssel im READy Manager?
Muss ich nach dem Kauf von API Access eine Lizenz aktivieren wie bei anderen Software-Produkten von Kamstrup?
Was bedeutet es, wenn einer der Infocode-Endpunkte eine Liste mit Zeichenfolgen ausgibt?
Neben intelligenten Zählern von Kamstrup umfasst mein Verteilnetz auch Drucksensoren von Kamstrup. Können die entsprechenden Daten über API Access übertragen werden?
In der Dokumentation des API Access Swaggers enthalten einige Endpunkte /v1/, andere wiederum /v2/. Ist eine Version der anderen vorzuziehen?
Welche Endpunkte muss ich bei meiner Authentifizierung verwenden?
Wenn Sie sich schon einmal gefragt haben, welchen Authentifizierungs-Endpunkt Sie verwenden sollen – hier ist der richtige:
https://signon.kamstrup.com/token.
Wir freuen uns auf das Gespräch mit Ihnen
Wie können wir Ihnen weiterhelfen?