Balluff BVS ID-M1280 F1 Series, Configuration Manual

Page: 222 / 316

BVS ID-M1280xF1-xx-xxx
64 english
•
•
1.
a.
b.
c.
d.
e.
f.
g.
h.
i.
j.
k.
l.
2.
a.
b.
c.
d.
e.
f.
g.
4.2 Communication via REST API
4.2.1 Introduction
The BVS ID offers a RESTful web interface (REST-API) which any HTTP client or library can access. HTTP
clients are e.g. wget, curl or openssl on a console. The REST-API serves as a machine-to-machine interface to
programmatically
receive parameters and product information and
execute action on the
BVS ID .
4.2.2 General API structure
The general entry point to the BVS ID API is http://HOSTNAME/api/balluff/v1/apidocs , where HOSTNAME is
either the device’s IP address or its host name as known by the respective DHCP server . Accessing this entry
point with a web browser lets the user explore the full API in YAML format.
For actual HTTP requests, the current API version is appended to the entry point of the API, i.e., http://
HOSTNAME/api/balluff/v1/ . All data sent to and received by the REST API follows the JavaScript Object
Notation (JSON). The API is designed to let the user retrieve so-called resources as listed in Available
resources using the HTTP GET request below.
Es gibt zwei verschiedene Kategorien von Nachrichten:
GET - Access one or more resources and return the result as JSON
Get API version
Get API description
Get product information
Get Open Source licenses of all used software libraries
Get manuals
Get condition monitoring data
Get device state (health state)
Get date/time
Get inspection ID
Get Results
Get results as a binary string
Get status
POST - Execute action on the BVS ID
Set Date/Time
Set Inspection ID
Set Reference Value
Trigger inspection
Flash LED
Login user
Logout user
NOTE
It is not necessary to adapt any system settings to use the REST API. The REST API is always active
and can always be used without restrictions.

NOTE
It is not necessary to adapt any system settings to use the REST API GET commands. For this request
type the REST API is always active and can always be used without restrictions.
To use the POST and login commands the
Protocol has to be switched to " REST-OT " in the Process
Communication tab of the System Settings .
