API Overview eng

This is an overview of the GUDE API (Application Programming Interface) for controlling and accessing GUDE devices with different protocols.

Our APIs are modular and thus uniform to use for all GUDE devices. We use a REST API. Devices can be automatically accessed through the following five different interfaces, which provide different ways to control and access configuration data and status information. Only HTTP(S) and the console (Command Line Interface) provide full access to the device.

From experience with successfully implemented customer projects, the following basic functions are important in an integration:

• Switching the outputs on and off
• Query of the port status
• Measurement data: voltage, current + residual current (RCM), current consumption, energy counter (one counter resettable)
• Status of the overvoltage protection (Over Voltage Protection)
• External sensor data: Temperature, Humidity and Air Pressure

API Overview
Protocol	Transport	Functional Scope	Positive / Negative	Further Information
CGI/JSON	HTTP(S)	Read/Write all Configuration Data Read/Write all Status Data	Positive: Complete functional scope Negative: Needs HTTP(S) Libraries and JSON Parser	EPC HTTP Interface HTTP JSON Sensor Data Demo Source-Code Switch Ports Read Sensor values
CLI Command Line Interface	Telnet / SSH / MQTT HTTP(S) / RS232	Read/Write all Configuration Data Read/Write all Status Data	Positive: Complete functional scope Positive: simple handling
SNMP	SNMPv2 / SNMPv3	Read/write state of the ports (Relay or eFuses) Read/Write Port names (Relay or eFuses) Read/Write state of port start configuration Read/Write configuration Buzzer Read/Write configuration of the power sources Read/Write configuration Fan Read measured values of external sensors Read measured values of all energy sensors Read NTP time and state Resetting the energy meters Read state of Over-voltage Protection	Positive: desired use in SNMP environment Negative: Device not completely configurable
Modbus TCP	Modbus TCP	Read/write state of the ports (Relay or eFuses) Read input states Read/Write configuration of the power sources Read/Write configuration Fan Read measured values of external sensors Read measured values of all energy sensors Read state of Over-voltage Protection	Positive: desired use in Modbus TCP environment Negative: Device not completely configurable	ModbusTCP
MQTT	MQTT	Distribution of messages via MQTT broker Distribution of sensor data via MQTT broker Execution of Console Commands	Positive: Publish data locally or in the cloud Positive: Complete range of functions through CLI