Produits phares
Quick Links
etapAPI est l'API RESTful publique d'ETAP et peut être utilisée à partir de n'importe quelle langue sur n'importe quel appareil. L'appareil peut être l'ordinateur sur lequel ETAP s'exécute ou un autre appareil sur le même réseau. etapAPI permet l'interopérabilité avec ETAP, ce qui permet l'automatisation, les scripts et les études à distance en tant que service aux appelants.
L'etapAPI est un service RESTful exécuté dans DataHub™, la passerelle d'ETAP pour tous les échanges de données. Il est utilisé par ETAP et des outils tiers via des connexions sécurisées (https). DataHub héberge divers services (internes et publics), mais l'etapAPI est le service le plus utilisé par les clients d'ETAP.
L'etapAPI est divisé en cinq sections principales : Application, Serveur DNP3, Données de projet, Études et Scénario. Ces sections peuvent toutes être explorées via la page Swagger, qui permet aux utilisateurs de visualiser et d'interagir avec l'API etap sans avoir à écrire de code client, et est entièrement basée sur un navigateur. La page Swagger permet aux utilisateurs d'expérimenter et de découvrir les fonctionnalités offertes par l'API etap.
Cette section contient des appels concernant l'application ETAP. Par exemple, dans cette section, il est possible de récupérer à la fois le nom d'utilisateur et le nom du projet.
Cette section contient des appels permettant d'effectuer des études. Par exemple, vous pouvez demander à ETAP d'exécuter une étude de flux de charge depuis la page Swagger.
Cette section contient les appels qui renvoient les données du projet. Par exemple, il est possible de demander la visualisation de tous les éléments du bus ou l'obtention des paramètres des éléments par type. Les utilisateurs peuvent également modifier les données du projet, par exemple créer/supprimer des éléments, modifier les propriétés des éléments pour les puissances nominales, le nom de l'élément, l'état de service et saisir les paramètres du cas d'étude pour les itérations, la précision et le temps de simulation.
Cette section contient des appels permettant d'interagir avec l'assistant de scénario ETAP. Grâce à lui, il est possible de déclencher à distance des études préconfigurées et d'invoquer des mises à jour de l'interface utilisateur.
Chaque instance d'ETAP expose une API REST dédiée à la consommation publique via http sécurisé (https). Une machine peut exécuter plusieurs instances ETAP (une par projet) ou une instance d'ETAP peut être mise en service par machine. Ce dernier est mieux adapté à un volume important de charges de travail parallèles (par exemple, l’exécution d’un grand nombre d’études en parallèle).
Les appelants peuvent appeler ETAP à partir de n’importe quel client compatible REST. Certains des clients avec lesquels nous travaillons actuellement :
Historiquement, ETAP prenait en charge les services SOAP via des fichiers WCF WSDL en tant que backend. Ces services sont en cours de migration vers l’alternative plus interopérable (REST). Par conséquent, bien qu’ETAP prenne actuellement en charge les services SOAP, ceux-ci seront bientôt obsolètes.
L'API REST d'ETAP est organisée en sections comme résumé par le tableau ci-dessous.
REST est l'acronyme de Representational State Transfer. Il s'agit d'un style architectural pour les systèmes hypermédias distribués et a été présenté pour la première fois par Roy Fielding en 2000 dans sa thèse.
Le transfert d'état représentationnel (REST) est un style d'architecture logicielle qui définit un ensemble de contraintes à utiliser pour la création de services Web. Les services Web conformes au style architectural REST, appelés services Web RESTful, assurent l'interopérabilité entre les systèmes informatiques sur Internet. Les services Web RESTful permettent aux systèmes demandeurs d'accéder et de manipuler des représentations textuelles de ressources Web en utilisant un ensemble uniforme et prédéfini d'opérations sans état. D’autres types de services Web, tels que les services Web SOAP, exposent leurs propres ensembles arbitraires d’opérations.
Obtenez un aperçu approfondi de nos logiciels d'ingénierie électrique en demandant une formation qui vous convient.
Découvrir maintenant
Testez ETAP gratuitement pendant 30 jours pour découvrir par vous-même les capacités des solutions ETAP. Essayez la vaste collection de modules et de résultats d'analyse d'ETAP sur cette plateforme de démonstration basée sur le cloud, à tout moment et en tout lieu. Commencez votre démo en ligne dès aujourd'hui !