MICRO-EPSILON colorSENSOR CFO Series, Instruction Manual

Page: 95 / 124

Page 95
Anhang | API Communication with Controller (Version 0.7.1)
colorSENSOR CFO
A 3 API Communication with Controller (Version 0.7.1)
A 3.1 Overview
The HTTP-based API allows interrogation and modification of the sensor configuration and current states.
All sensor details are available in this manner. For example, the integrated web application communicates
with the sensor exclusively via the API.
The API thus allows integration of the sensors in your own tool chain and processes (data collection, ERP
integration, backup, monitoring, ...).
The API is REST compatible, thus supporting following HTTP requests:
- GET
ƒ
Resource query, (e.g. current sample)
- POST
ƒ
Generation of a resource (e.g. new color sample)
- PUT
ƒ
Modification of a resource (e.g. changing a tolerance)
- DELETE
ƒ
Deleting a resource (e.g. trigger action)
A 3.2 Examples of Manual Queries
The following manual queries are intended only as examples for use of the API.
All programming languages and development environments typically provide HTTP libraries with simple ac-
cess for integration of your own tools.
A 3.3 Sample Tools for Manual Queries
Environment Tool recommendation
Command line cURL
Windows PowerShell Invoke RestMethod