Balluff BVS ID-M1280 F1 Series, Configuration Manual

Page: 68 / 316

BVS ID-M1280xF1-xx-xxx
66 deutsch
•
•
1.
a.
b.
c.
d.
e.
f.
g.
h.
i.
j.
k.
l.
2.
a.
b.
c.
d.
e.
f.
g.
4.2 Kommunikation über REST API
4.2.1 Einleitung
Der BVS ID bietet eine RESTful-Web-Schnittstelle (REST API), auf die jeder HTTP-Client und jede HTTP-
Bibliothek zugreifen kann. HTTP-Clients sind z.B. wget, curl oder openssl auf einer Konsole. Die REST API dient
als Maschine-Maschine-Schnittstelle für folgende programmgesteuerte Aufgaben:
Abrufen von Parametern und Produktinformationen.
Ausführen einer Aktionen auf dem
BVS ID .
4.2.2 Allgemeine Struktur der Programmierschnittstelle
Der allgemeine Einstiegspunkt zur Programmierschnittstelle (API) des BVS ID ist HTTP://HOSTNAME/api/balluff/
v1/apidocs wobei HOSTNAME entweder die IP-Adresse des Geräts ist oder sein dem jeweiligen DHCP-Server
bekannter Hostname. Greift der Benutzer über einen Webbrowser auf diese Adresse zu, wird die
Programmierschnittstelle im YAML-Format angezeigt.
Für die eigentlichen HTTP-Anfragen wird dem Einstiegspunkt der Programmierschnittstelle die aktuelle Version
der Schnittstelle als Postfix angehangen, d.h.
http://HOSTNAME/api/balluff/v1/ . Alle Daten, die an die REST API
gesandt und von ihr empfangen werden, entsprechen dem JSON-Datenformat (JavaScript Object Notation).
Ausnahmen von dieser Regel werden unten erwähnt. Die Programmierschnittstelle ist so gestaltet, dass der
Benutzer die aufgelisteten
Ressourcen über die folgende HTTP-Anforderung abrufen kann.
Es gibt zwei verschiedene Kategorien von Nachrichten:
GET - Zugriff auf eine oder mehrere Ressourcen und Rückgabe des Ergebnisses im JSON-Format
API-Version abfragen
API-Beschreibung abfragen
Produktinformationen abfragen
Open Source Lizenzen verwendeter Programmbibliotheken abfragen
Handbuch abfragen
Diagnosewerte abfragen
Gerätestatus abfragen (Health State)
Datum/Uhrzeit abfragen
Inspektions-ID abfragen
Ergebnisse abfragen
Ergebnisse als Binärstring abfragen
Status abfragen
POST - Eine Aktion auf dem BVS ID ausführen
Datum/Uhrzeit setzen
Inspektions-ID setzen
Referenzwert setzen
Inspektion triggern
LED aufleuchten lassen
Benutzer anmelden
Benutzer abmelden
HINWEIS
Um die REST API GET-Befehle zu verwenden, ist es nicht nötig, diese als Kommunikationskanal in den
Systemeinstellungen zu setzen. Die REST API ist immer aktiv und kann verwendet werden.
Für die POST- und Login-Befehle muss als
Protocol " REST-OT " im Process Communication Tab der
System Settings ausgewählt werden.
