API Guide

Key integration concepts
This section covers key integration concepts that are applicable to all of the use cases that are addressed in the next section.
Topics:
• Base URI
• Security
• Authentication mechanisms
• Resource operations
• Security considerations
• Data filtering and sorting
• Data pagination
• Request headers
• Response codes
• Response headers
Base URI
The base URI for a REST request must be in the following format:
https://<HOST_ADDRESS>/api/<SERVICE_NAMESPACE>
Hereafter, https://<HOST_ADDRESS>/api/ is referred to as the <BASE_URI>.
An example of a base URI for OpenManage Enterprise is as follows:
https://192.168.0.1/api/SessionService/Sessions
Security
The REST services will only be exposed through HTTPS to ensure that the common threats associated with the HTTP traffic are
mitigated. The administrator will have the option of updating the SSL self-signed certificate with a customer-provided certificate (for
example, by uploading a PKCS-12 certificate or by signing an application-generated CSR).
Authentication mechanisms
There are several common schemes for enabling authentication of REST requests. The following is a summary of the most common
schemes:
Basic Authentication
The authorization header in the request has the base-64 encoding of the credentials (username and password). If the credentials are not
provided, a 401 (Authorization Failure) error is returned. Because the encoding is weak, this mechanism is only supported when SSL/TLS
is used for the transport.
X-Auth-Token Authentication
An alternative to Basic Authentication is the x-auth-token authentication. Users will execute the SessionService REST API to start a
session:
POST https://10.35.0.133/api/SessionService/Sessions
Input
{
"UserName":"root",
"Password":"linux",
"SessionType":"API"
}
2
Key integration concepts 5