Top Produkte
Quick Links
etapAPI ist die öffentlich zugängliche RESTful-API von ETAP und kann in jeder Sprache auf jedem Gerät genutzt werden. Das Gerät kann der Computer sein, auf dem ETAP ausgeführt wird, oder ein anderes Gerät im selben Netzwerk. etapAPI ermöglicht die Interoperabilität mit ETAP, wodurch Automatisierung, Skripting und Remote-Studien als Service für Anrufer bereitgestellt werden.
Die etapAPI ist ein RESTful-Dienst, der im DataHub™ ausgeführt wird, dem Gateway von ETAP für den gesamten Datenaustausch. Er wird von ETAP und Drittanbieter-Tools über eine sichere Verbindung (https) genutzt. Während der DataHub verschiedene Dienste (interne und öffentliche) hostet, ist die etapAPI der von ETAP-Kunden am häufigsten genutzte Dienst.
Die etapAPI ist in fünf Hauptabschnitte unterteilt: Anwendung, DNP3-Server, Projektdaten, Studien und Szenario. Diese Abschnitte können alle über die Swagger-Seite erkundet werden. Sie ermöglicht es Benutzern, etapAPI anzuzeigen und damit zu interagieren, ohne Clientcode schreiben zu müssen. Die Seite ist vollständig browserbasiert. Auf der Swagger-Seite können Benutzer experimentieren und die in etapAPI angebotenen Funktionen anzeigen.
Dieser Abschnitt enthält Anrufe zur ETAP-Anwendung. In diesem Abschnitt ist es beispielsweise möglich, sowohl den Benutzernamen als auch den Projektnamen abzurufen.
Dieser Abschnitt enthält Aufrufe zur Durchführung von Studien. Beispielsweise kann man ETAP auf der Swagger-Seite bitten, eine Lastflussstudie durchzuführen.
Dieser Abschnitt enthält Aufrufe, die Projektdaten zurückgeben. Beispielsweise können Sie die Anzeige aller Buselemente anfordern oder Parameter für Elemente nach Typ abrufen. Benutzer können auch Projektdaten ändern, beispielsweise Elemente erstellen/löschen, Elementeigenschaften für Leistungsangaben, Elementnamen und Servicestatus ändern und Studienfalleinstellungen für Iterationen, Präzision und Simulationszeit eingeben.
Dieser Abschnitt enthält Aufrufe, die die Interaktion mit dem ETAP-Szenarioassistenten ermöglichen. Mit dem ETAP-Szenarioassistenten können vorkonfigurierte Studien remote gestartet und UI-Updates aufgerufen werden.
Jede Instanz von ETAP stellt eine dedizierte REST-API zur öffentlichen Nutzung über sicheres http (https) bereit. Auf einer Maschine können mehrere ETAP-Instanzen ausgeführt werden (eine pro Projekt) oder es kann eine ETAP-Instanz pro Maschine in Betrieb genommen werden. Letzteres eignet sich besser für ein großes Volumen paralleler Arbeitslasten (z. B. die parallele Durchführung einer großen Anzahl von Studien).
Anrufer können ETAP von jedem REST-kompatiblen Client aus anrufen. Einige der Kunden, mit denen wir derzeit zusammenarbeiten:
In der Vergangenheit unterstützte ETAP SOAP-Dienste über WCF-WSDL-Dateien als Backend. Diese Dienste werden auf die interoperablere Alternative (REST) migriert. Obwohl ETAP derzeit SOAP-Dienste unterstützt, werden diese daher bald veraltet sein.
Die REST-API von ETAP ist in Abschnitte unterteilt, die in der folgenden Tabelle zusammengefasst sind.
REST ist ein Akronym für Representational State Transfer. Es handelt sich um einen Architekturstil für verteilte Hypermediasysteme und wurde erstmals im Jahr 2000 von Roy Fielding in seiner Dissertation vorgestellt.
Representational State Transfer (REST) ist ein Softwarearchitekturstil, der eine Reihe von Einschränkungen definiert, die zum Erstellen von Webdiensten verwendet werden sollen. Webdienste, die dem REST-Architekturstil entsprechen, sogenannte RESTful-Webdienste, bieten Interoperabilität zwischen Computersystemen im Internet. RESTful-Webdienste ermöglichen den anfordernden Systemen den Zugriff auf und die Bearbeitung von Textdarstellungen von Webressourcen mithilfe eines einheitlichen und vordefinierten Satzes zustandsloser Operationen. Andere Arten von Webdiensten, wie etwa SOAP-Webdienste, stellen ihre eigenen beliebigen Operationssätze bereit.
Erhalten Sie einen vertieften Einblick in unsere Elektrotechnik-Software und fordern Sie eine für Sie passende Schulung an.
Jetzt entdecken
Testen Sie ETAP 30 Tage lang kostenlos und überzeugen Sie sich selbst von den Leistungsfähigkeit der ETAP-Lösungen. Testen Sie ETAPs umfangreiche Sammlung an Modulen und Analyseergebnissen auf dieser Cloud-basierten Demo-Plattform – jederzeit und überall. Starten Sie noch heute Ihre Online-Demo!