Secure Connect API
Die Secure Connect-API (Application Programming Interface) gibt den externen Systemen Zugriff auf Secure Connect-Daten. Die folgenden Informationen sind über die APIs zugänglich:
- Alarmdaten
- Live-Daten
- Anlagendaten
- Gerätedaten
- Kundendaten
- Benutzerdaten
Die Secure Connect-APIs werden nur für den Empfang der Daten verwendet. Der Benutzer kann die Geräte nicht über die Secure Connect-APIs steuern oder Daten bearbeiten, indem er einen externen Client hinzufügt.
Externen Client hinzufügen
- Melden Sie sich bei Secure Connect an.
- Gehen Sie zu Admin > Kunden.
- Einen Kunden auswählen.
- Öffnen Sie die Registerkarte Externe Clients.
- Klicken Sie auf die Schaltfläche Hinzufügen.
- Geben Sie einen Namen ein.
- Geben Sie eine Beschreibung ein.
Es ist optional, eine Beschreibung zu schreiben. - Klicken Sie auf Save (Speichern)
Ein externer Client wird erstellt und der Benutzer erhält eine eindeutige Auth0 Client-IDund ein einmaliges Auth0 Client-Geheimnis. Es ist wichtig, das Client-Geheimnis zu speichern, da es nur einmal angezeigt wird. Für den Zugriff auf die Secure Connect REST APIs ist das Client-Geheimnis erforderlich. Wenn der Benutzer das Client-Geheimnis vergisst, muss ein neuer externer Client erstellt werden.
API-Dokumentation
Die Secure Connect API-Dokumentation ist in der Secure Connect-Anwendung verfügbar. Zugriff auf die Secure Connect API-Dokumentation:
- Melden Sie sich bei der Secure Connect-Anwendung an.
- Klicken Sie auf das Profilsymbol in der oberen rechten Ecke.
- Klicken Sie auf die externen Client-Ressourcen .
- Klicken Sie auf den API-Link, um die Secure Connect API YAML-Datei herunterzuladen.
Die heruntergeladene Datei enthält die folgenden Informationen.
- REST API-Pfade
- Anfrageformat
- Antwortformat
- Schemainformationen
Um weitere Informationen über den Secure Connect-Authentifizierungsmechanismus und den Anruf der Secure Connect-APIs zu erhalten, klicken Sie auf den Link Installationshandbuch auf den Ressourcen des externen Clients. Die heruntergeladene Datei enthält die folgenden Informationen:
- Einrichten eines externen Clients
- Abrufen des JWT-Tokens zur Authentifizierung
Verwandte FAQs
Viele Nutzer hatten ähnliche Fragen zu Analytics, Live Data, API und OPC UA Connector.