Balluff BVS ID-M1280-F1 Series, Configuration Manual

Page: 234 / 342

BVS ID-M1280xF1-xx-xxx
60 english
•
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. The REST-
API serves as a machine-to-machine interface to programmatically
receive parameters and product information.
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.
Request type Description
GET Access one or more resources and return the result as JSON.
As for the request responses, the defined return codes for the API are:
Status Code Description
200 OK The request was successful; the resource is returned as JSON.
400 Bad Request A required attribute or argument of the API request is missing
or invalid.
404 Not Found A resource could not be accessed; e.g., an ID for a resource
could not be found.
403 Forbidden Access is (temporarily) forbidden; e.g., some parameters are
locked.
429 Too many requests Rate limited due to excessive request frequency.
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.
