Cisco Cisco TelePresence MCU 4510 Developer's Guide

Page of 296
Encoding
Your application can encode messages as ASCII text or as UTF-8 Unicode. If you do not specify the
encoding, the API assumes ASCII encoding. You can specify the encoding in a number of ways:
Specify encoding with HTTP headers
There are two ways of specifying UTF-8 in the HTTP headers:
n
Use the Accept-Charset: utf-8 header
n
Modify the Content-Type header to read Content-Type: text/xml; charset=utf-8
Specify encoding with XML header
The <?xml> tag is required at the top of each XML file. The API will accept an encoding attribute for this tag;
that is, <?xml version="1.0" encoding="UTF-8"?>.
Authentication
The application must authenticate itself to the MCU. Also, because the interface is stateless, the application
must authenticate with the MCU every time it issues a command to the API.
Unless the device is configured to allow (or require) certificate-based login, all messages must contain a user
name and password as follows:
Parameter name
Type
Short description
authenticationUser
string
Name of a user with sufficient privilege for the operation
being performed. The name is case sensitive.
authenticationPassword
string
The password that corresponds with the given
authenticationUser
. The API ignores this parameter if
the stored user has no password.
Note: Authentication information is sent using plain text and should only be sent over a trusted network.
Certificate-based authentication modes
Client
certificate
security
option
API authentication rules
Not required
No effect on API.
Verify
certificate
Messages must have valid username and password values (authenticationUser and
authenticationPassword
parameters). To successfully make an HTTPS connection, the
messages must also contain a valid client certificate that was issued by an authority that the MCU
trusts.
Cisco TelePresence MCU API 2.10
Page 8 of 296
Overview
Encoding