The REST API interface corresponds to the standard of the IO-Link community, which
was defined in the document “JSON Integration for IO-Link” with version 1.0.0 (as of
March 2020, part number 10.2020).
8.2.1.1 General description of the interface
The REST API is a client-server interface and enables the client to request data from
the server via defined resources. The REST API is stateless, which means that no
information about the connection status and no information about the server or client
is required.
The operation is based on HTTP methods. Common HTTP methods are GET, POST,
PUT and DELETE. For the SIG350, the GET and POST request methods are particularly
relevant, where the request and response data is represented in JSON format. JSON,
or JavaScript Object Notation, is a minimal, visually readable format for structuring
data. It is mainly used to transmit data between a server and a web application as an
alternative to XML.
Table 27: HTTP methods
HTTP method Description
GET Requests the specified data from the server (= data is only read and
not changed)
POST The payload is transmitted to the server (= write data)
DELETE Deletes the specified resources on the server (= data is deleted)
8.2.1.2 API documentation
The current documentation (also called Open API) of the API interface can be down‐
loaded at www.sick.de/SIG350. This document defines all available variables and
methods of the API interface of the SIG350.
The OPEN API documentation is in JSON/YAML format and can be used with appropri‐
ate software tools such as Swagger, Postman or Insomnia.
8.2.1.3 API structure
Request
To request data, a command must be sent to the server, in this case the SIG350. This
command is structured in HTTP format:
URL schema: http://[IP-Adresse]/[BasePath]/[Resource]
•
The IP address corresponds to the valid IP address of the module. The default
IP address of the SIG350 is 192.168.0.1. If necessary, the default address has
already been changed via the PLC or the web interface.
•
The BasePath is defined in the standard of the IO-Link community: /iolink/v1
•
The resource is used to address the corresponding parameter which is to be read
or written:
E.g.: /masters/{masterNumber}/ports/{portNumber}/configuration
An overview of the available variables and methods can be found in section XXX and in
the standard of the IO-Link community.
Thus, an example URL for reading the port configuration of port S3 is as follows:
http://192.168.0.1/iolink/v1/masters/1/ports/3/configuration
NOTE
8 OPERATION
44
O P E R A T I N G I N S T R U C T I O N S | Sensor Integration Gateway - SIG350 8027834./2022-06-10 | SICK
Subject to change without notice
To Next Page
Loading...
