10 External APIs
49
10
External APIs
The controller can be accessed programmatically using a number of protocols and APIS, including:
• the REST-like API (over HTTP),
• JSON-RPC (over HTTP),
• SNMP,
• MQTT,
• UPnP
10.1
Common external API settings
External APIs
Allow JSON-RPC:
Allow REST-style API:
Enable UPnP service:
Enable SNMP service:
Enable MQTT client:
Relax non-HTML method CSRF checks:
Relax non-HTML content type CSRF
checks:
Submit
Common external API settings
Each of the external APIs can be enabled separately.
HTTP APIs perform cross-site request forgery checking to make sure they are not called by a misguided browser
without JavaScript, bypassing browser security checks (a custom header needs to be present in the requests).
Browsers can normally issue GET and POST requests with URL-encoded or multipart content types; you can tick
the corresponding "relax ... checks" checkboxes to skip the checks in cases where the method or content type
indicates that the request couldn't have been sent by a browser without JavaScript.
10.2
REST-like API
Name
(
view detailed description
)
User-visible relay name
string
DLI Controller
PUT
represents a value in persistent storage
write is denied if not
administrative user
no synchronization requirements
Up to Relay object
Allowed methods:
GET
PUT
PATCH
REST-like API demo
DLI LPC9 User’s Guide: 1.7.24.0
Summary of Contents for LPC9
Page 1: ...DLI LPC9 User s Guide 1 7 24 0 ...
Page 81: ......