7.8.1 Authentication
Logging in
In order be able to read or modify parameters through the Web API, the user must first au-
thenticate by sending the following request:
”http://IP_ADRESS/api/auth?password=PASSWORD
Where IP_ADRESS is the IP Adress of the unit and PASSWORD is the password set in the Font
Panel (System ⇒ Users ⇒ Password)
The unit will respond with a page with xml content (text/xml) and the following content if the
login attempt is correct:
<response login=”true” sid=”884498006”/>
Note that the sid value will be different in different sessions.
Logging Out
The following request performs a ’log out’. This request should be issued when finished using
the unit through the Web API.
”http://IP_ADDRESS/api/logout”
7.8.2 Setting A Parameter
To set parameters, use the following request:
”http://IP_ADRESS/api/setParameter?id=PARAMETER_NAME&value=PARAMETER_VALUE”
The unit will respond with a page with xml content (text/xml) and the following if the request
was successful:
”<response success=”true”/>”
Please refer to the ”Parameter list” subsection for a list with all the parameters available in the
unit.
E.g. To set the frequency to 99 MHz, issue the following request:
”http://192.168.5.34/api/setParameter?id=transmitter.frequency&value=99M”
Note that for parameters containing brackets in their name (such as alarm[1].email.active),
these characters should be escaped and must be written as ”%5B” and ”%5D” in the html
request. E.g.:
”http://192.168.5.34/api/setParameter?id=alarm%5B1%5D.email.active&value=yes”
46
To Next Page
Loading...
