CTMS - Introduction and initial steps

Overview

The CTMS API is a HAL API. The responses of REST calls contain links to other resources and other functionality of the API. The page Understanding HAL-based APIs tells you all you need to know about HAL.

Preparation

If you want to use the CTMS API, you must first register and request an app record to use:

Implementation steps

The first steps you have to take are the same for all of the CTMS functionality:

  1. Authenticate to get an access token.

  2. Refresh the access token as long as you need it.

  3. Query the CTMS Registry. This gives you a core set of HAL link rels.

  4. Follow the link rels to query or modify CTMS resources.

  5. All CTMS resources are again HAL resources with link rels that you can use for follow-up queries and actions.

See the following Quick Start guides to learn how to…​

 

Previous page: -

Up: Quick start

Next page: Authentication