Communication Via Rest Api - Balluff BVS ID-M1280-F1-Serie Konfigurationsanleitung

BVS ID-M1280xF1-xx-xxx
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.

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.
4.2.2 General API structure
The general entry point to the
either the device's IP address or
point with a web browser lets the user explore the full API in YAML format.
For actual HTTP requests,
HOSTNAME/api/balluff/v1/.
Notation (JSON). The API is designed to let the user retrieve so-called resources as listed
resources using the HTTP GET request below.
Request type
GET
As for the request responses, the defined return codes for the API are:
Status Code
200 OK
400 Bad Request
404 Not Found
403 Forbidden
429 Too many requests
60 english
BVS ID API is http://HOSTNAME/api/balluff/v1/apidocs, where HOSTNAME
its host name as known by the respective DHCP
the current API version is appended to the entry point of the API, i.e.,
All data sent to and received by the REST API follows the JavaScript Object
Description
Access one or more resources and return the result as JSON.
Description
The request was successful; the resource is returned as JSON.
A required attribute or argument of the API request is missing
or invalid.
A resource could not be accessed; e.g., an ID for a resource
could not be found.
Access is (temporarily) forbidden; e.g., some parameters are
locked.
Rate limited due to excessive request frequency.
is
server. Accessing this entry
http://
in Available