ServSwitch iPATH Manager API Documentation
API Documentation
API version: 2
Changelog
v2 (IPATH v2.3) - added get_devices, get_channels, connect_channel, disconnect_channel. Updated version compatibility information.
v1 (IPATH v1.3) - added login, logout, get_presets, connect_preset, disconnect_preset
Methods
login logout get_devices get_channels get_presets connect_channel connect_preset disconnect_channel disconnect_preset
login
This method was last updated in API version 1, and is compatible with API requests from version 1 onwards.
The API will require a valid IPATH user's login credentials to be presented in the first request. The API will return an authentication code, which must be passed in all future requests. This authentication code can be
The concept of an “anonymous user” can apply to the API. If no login username and password are provided, the API will return an authentication token for the anonymous user (either the same one as for the OSD, or else an “anonymous API user” account can be created).
Input parameters:
-username
-password
-v (the IPATH API version this request is designed for)
Output values:
-timestamp - the current server time
-version - the current API version number
-token - an authentication code for future API requests
-success
NOTE: login examples are on the next page.
Page 3 |