Understanding the Platform APIs

The Platform APIs documented in this chapter are described in Sections:

Except for the frontend service API, described independently in the Web Client Library documentation, the Platform provides users with:

  • An OpenAPI documentation that describes the aforementioned services endpoints, as well as the input parameters and response format. For convenience, an OpenAPI file is provided to allow the generation of a custom client for any language supported using OpenAPI Generator. For more details, please refer to the official OpenAPI and OpenAPI Generator documentations.

  • A JavaDoc documentation that describes the APIs of the Java classes, methods, fields, and other code elements within the Platform.

Note:

Note that, to interact with the Platform API, the user must be authenticated with an API key. For more details, please refer to Chapter Authenticating with API Keys.