GETTING STARTED

Overview

This page will help you to get started with using the Self-Service RESTful API.

Authentication

Access to the Self-Service RESTful API is controlled using an User API Key.

In order to access the Self-Service RESTful API, you must meet the following conditions:

• You must have a valid User API Key;

• You must be provided with access to RESTful API methods by the Administrators; and

• Your User API Key is supplied in the Header X-SSAPI-KEY for each request to the API endpoint.

All requests to the API must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate all requests.

Accessing the RESTful API

Access to the RESTful API, including scope of data available, is restricted to the users' data within the application.

By default, every user in the system does not have access to any of the RESTful API methods - including Administrators. Access to the RESTful API must be provided explicitly by an Administrator, and is controlled on an individual method basis.

A user can see their access to the RESTful SSAPI by viewing the SSAPI module in the application.

The following warning and padlock indicate that the RESTful API Method is not available:

An Administrator can provide a user with access to the RESTful SSAPI by accessing Users > (select user) > Access > Self-Service RESTful API > Add Access