Reference Guide

SupportAssist Enterprise
6 REST API Guide – SupportAssist Enterprise
1 Key Integration Concepts
This section covers key integration concepts that are applicable to all the use cases that are addressed in the
next section.
1.1 Client Integration Overview
The REST client makes standard HTTP(S) requests to the REST API end-point. Each request is sent using a
HTTP verb (for example, PUT, GET, POST, and DELETE) and includes a message body in JSON format. The
response uses a standard HTTP status code.
The REST client can be developed in a wide variety of programming languages (for example, C#, Java, and so
on) or scripting languages (for example, Python, Perl, and so on) that have basic support for HTTPS
communication and are capable of constructing and parsing JSON payloads.
1.2 Base URI
The base URI for a REST request must be in the following format:
https://<HOST_ADDRESS>:<PORT_NUM>/
The parameters used in the base URI are described in the following table.
Parameter
Description
HOST_ADDRESS
The network address of the system where SupportAssist Enterprise is
installed. The network address could be a DNS host name or an IP
address.
PORT_NUM
The port number that has been specifically opened on the web stack for
API communication. This should be the standard port used for SSL
communications or a port that is registered with Internet Assigned
Numbers Authority (IANA) for that product.
An example of a base URI for SupportAssist Enterprise is as follows:
https://192.168.0.1:5700/
The rest of the document will reference this example as the <BASE_URI>.
1.3 Security
The REST services will *only* be exposed through HTTPS to ensure that the common threats associated with
HTTP traffic are mitigated. This is available only for admin privileged users only.
1.4 Authentication Mechanisms
The authentication process starts when the client makes a request for a token from the server by providing its
credentials. In response, SupportAssist Enterprise returns an access token and a refresh token. The refresh
token is valid for 24 hours, while the access token is valid for 30 minutes. After the access token has expired,
you can generate a new access token by using the refresh token.