neoom CONNECT

API Guide

neoom stellt zwei unterschiedliche Programmierschnittstellen (APIs) zur Verfügung, die sich vor allem an Systempartner aber auch an versierte Nutzer richten.

Erfahre auf dieser Seite, wie sich diese unterscheiden, wie du darauf zugreifen und sie für deine Projekte nutzen kannst. Wir leiten dich durch den Zugangsprozess und du findest über diese Seite auch die detaillierte Entwicklerdokumentation zu den APIs.

Laptop mit neoom Screen auf Schreibtisch

WELCHE APIs GIBT ES?

neoom BEAAM API (beta)

Die lokale API wird über den neoom BEAAM bereitgestellt. Auf sie kannst Du über das lokale Netz, in dem sich der BEAAM befindet, zugreifen. Sie dient zum Beispiel zur Integration von externen Visualisierungssystemen. Zu diesem Zweck stellt sie alle Zustände, Metriken und Energieflussdaten zur Verfügung, die an dem Standort verfügbar sind.

 

neoom Cloud API

Auf die Cloud API kann der Nutzer ortsunabhängig zugreifen. Sie ermöglicht den Zugriff auf Energieflussdaten mehrerer Standorte (sofern autorisiert), zum Beispiel für die Nutzung mit einem Cloud Service.

ÜBER DIE BEAAM API

neoom BEAAM API (beta)

Nützliche Begriffe und Komponentennamen
Während der Interaktion mit unserem Ökosystem, wirst du immer wieder auf bestimmte Begriffe und Namen von Komponenten stoßen. Eine Erklärung dazu findest du hier: Konzepte & Begriffe

Was ist der neoom BEAAM
Jeder neoom CONNECT Standort ist mit einem BEAAM ausgestattet, der als zentraler Knotenpunkt dient, der die Konnektivität zu deinem Energiegeräten am Standort zur Überwachung und Steuerung bereitstellt. Energiegeräte gelten all jene, die mit Energie oder Energiemanagement in Zusammenhang stehen (Batteriespeicher, Wechselrichter, Wärmepumpen, Ladestationen, Heizstäbe usw.).

Mit dem BEAAM ist neoom in der Lage, neoom CONNECT-Funktionen wie historische und aktuelle Metriken in der neoom APP und auch Energiemanagement-Funktionen wie die "PV-Überschuss basierte Gerätepriorisierung" zur Verfügung zu stellen.

Darüber hinaus ermöglicht die enge Integration mit der neoom CONNECT Cloud die sichere Übergabe rechenintensiver Energiemanagementaufgaben an unsere Rechenzentren, wie KI und maschinelles Lernen, die das Laden deiner Batterie auf der Grundlage dynamischer Netzpreise optimieren. Der BEAAM macht es einfach, diese Energiegeräte in ein bestehendes Smart-Home-System zu integrieren, indem es alle herstellerspezifischen Implementierungsdetails, Protokolle und Formate abstrahiert und normalisierte und saubere Daten als entwicklerfreundliche JSON über eine REST-API bereitstellt.

API-Dokumentation
Einzelheiten zur Verwendung der BEAM-API findest du in den Dokumenten auf developer.neoom.com.
Die API stellt Daten zu Standort und Geräten am Standort bereit.

Standortspezifische Daten
Ein Standort wird durch seine Metadaten definiert, die durch die Standortkonfiguration dargestellt werden.

Neben den standortspezifischen Metadaten enthält die Standortkonfiguration die Metadaten für alle Geräte (Things; siehe auch Konzepte & Begriffe) einschließlich deren IDs, bereitgestellte Daten, Datenformate und Maßeinheiten.

Darüber hinaus enthält die Standortkonfiguration auch die gleichen Metadaten für den Energiefluss (siehe Konzepte & Begriffe), der Teil des Standortstatus ist.

Der Energiefluss ist eine abgeleitete Sicht auf die Gerätezustände und besteht aus:

  • Energiedaten
    • Erzeugte Energie, verbrauchte Energie, aus dem Netz entnommene und an das Netz abgegebene Energie, in der Batterie gespeicherte Energie, insgesamt verbrauchte Energie
  • Leistungsdaten
    • Strom aus der PV-Anlage, Strom, der aus dem Netz geliefert oder in das Netz eingespeist wird, Strom, der von allen Geräten am Standort verbraucht wird.

Weitere Informationen findest du in den Dokumentationen:

Gerätespezifische Daten
Die API stellt Energiedaten, Leistungsdaten und Statusdaten von Geräten zur Verfügung, die über den BEAAM mit neoom CONNECT verbunden sind und von diesem gesteuert werden.

Die über die BEAAM API verfügbaren Daten sind normalisiert. Das heißt, egal welche Einheit oder welches Format ein Energiegerät liefert, die BEAAM API übernimmt die Konvertierung und liefert verlässliche Daten für jeden unterstützten Hersteller, zum Beispiel wird Energie immer in Wh angegeben, auch wenn der Zähler nur kWh meldet.

Es ist zu beachten, dass die BEAAM API keine Persistenz, Langzeitverfolgung oder Aggregationen bietet. Dies bedeutet, wenn z.B. ein Zähler ausgetauscht wird, sind die Daten des alten Zählers nicht mehr über die API verfügbar und nur die Daten des neuen Zählers abrufbar, so wie sie von diesem gemeldet werden.

Eine Liste der gerätespezifischen Datenpunkte, die über die API ausgelesen werden können, findest du in der API-Spezifikation:

Schreibender Zugriff auf neoom BEAAM API
Es können keine Daten über die API in den BEAAM geschrieben werden.

neoom BEAAM API (beta)

Anwendungsbeispiele

neoom_round_c

Datenvisualisierung

 

Energie- und Leistungsdaten für Standort oder einzelne Geräte in externen Anwendung

neoom_round_c

Datensammlung

 

von historischen Energie- und Leistungsdaten zu Berichterstellungszwecken

neoom_round_c

Belegung von Ladestationen

 

Anzeige über eine externe Anwendung, welche Ladestation an Standort belegt ist oder nicht

neoom_round_c

Anlagenüberwachung

 

Monitoring der Anlage mit einem externen System

ÜBER DIE NEOOM BEAAM API

Zugang zur BEAAM API (beta)

Bitte beachte, dass du für die folgenden Schritte ein Standortinhaber:in sein musst, der/die über die erforderlichen Zugriffsrechte verfügt:

  1. Navigiere zu neoom CONNECT und melde dich mit deinen Anmeldedaten an.
  2. Navigiere zu der Seite, für die du den API-Token anfordern möchtest.
  3. Öffne über die Seitenleiste die Seite API Keys. (Screenshot 1, Step 1)
  4. Klicke auf Create BEAAM API key erstellen. (Screenshot 1, Step 2)
  5. Verwende den API key, wie in den API Docs beschrieben. (Sreenshot 2) 

neoom behält sich aus Sicherheitsgründen das Recht vor, die einzelnen API-Tokens zu ändern. Wir informieren dich direkt auf der API-Token Website, wenn eine solche Änderung erfolgt.

 

Detail BEAAM API (beta) Dokumentation >

beaam API step 1
Api zugang_step2

ÜBER DIE CLOUD API

neoom Cloud API

Auf die Cloud API kann der/die Nutzer:in ortsunabhängig zugreifen. Sie ermöglicht den Zugriff auf Energieflussdaten mehrerer Standorte (sofern autorisiert), zum Beispiel für die Nutzung mit einem Cloud Service.

Die neoom CLOUD API stellt Energieflussdaten über eine API zur Verfügung, die in der Cloud gehostet werden. Das bedeutet, dass es nicht erforderlich ist, sich im gleichen Netzwerk wie der BEAAM zu befinden, um auf die Daten zuzugreifen. Da die API in der Cloud gehostet wird, ist es auch möglich, Daten für mehrere Standorte abzurufen, sofern der/die Benutzer:in dazu berechtigt ist.

ÜBER DIE NEOOM CLOUD API

Zugang zur Cloud API

 

Bitte beachte, dass du für die folgenden Schritte ein Standortinhaber:in sein musst, der/die über die erforderlichen Zugriffsrechte verfügt:

  1. Navigiere zu neoom CONNECT und melde dich mit deinen Anmeldedaten an.
  2. Navigiere zu der Seite, für die du den API-Token anfordern möchtest.
  3. Öffne über die Seitenleiste die Seite API Keys. (Step 1)
  4. Klicke auf Create API key erstellen. (Step 2)
  5. Verwende den API key, wie in den API Docs beschrieben.

 

Detail Cloud API Dokumentation >

cloud API_step1
cloud API step2

RECHTLICHE HINWEISE

Haftungsausschluss

  • Die Nutzung der neoom APIs ist nur für erfahrene Personen mit IT- und Programmierkenntnissen zu empfehlen.
  • Die neoom BEAAM API befindet sich derzeit in der BETA-Phase.
  • Bitte beachte, dass wir während der BETA-Phase auch prüfen, ob die API für die Anwendungsfälle unserer Kund:innen geeignet ist. Folglich können API Änderungen jeglicher Art (einschließlich Funktionserweiterungen und -einschränkungen) ohne Vorankündigung und ohne Kompatibilität mit früheren Versionen auftreten.
  • Die neoom BEAAM API ist während der BETA-Phase kostenlos, neoom behält sich das Recht vor, die Nutzung der API nach der Veröffentlichung kostenpflichtig zu machen.
  • neoom haftet nicht für Schäden oder fehlerhaftes Systemverhalten, die aus der Nutzung dieser APIs resultieren. Darüber hinaus leistet neoom keinen Support und übernimmt keine Garantie für die korrekte Funktionalität der APIs.
  • Darüber hinaus hat neoom das Recht, die Nutzung der APIs einzuschränken, wenn die Nutzung der APIs den Geschäftsinteressen von neoom entgegensteht.
Neoom World