Introduction

Welcome to the developer guide of the API. This document is designed to help developers understand the basics of working with our API, including how to use OpenID for authentication and OpenAPI for connecting and testing.

Note: The API is currently in beta and subject to major changes.

Versioning

All endpoints in our API accept an api-version parameter. This parameter allows you to specify which version of the API you wish to use. The current version of the API is 1.

GET selfurl/api/app/product?api-version=1.0

If you do not specify an api-version, the API will default to the latest version. Be aware that the latest version is subject to change as new versions are released. Therefore, it is recommended to always specify the version to avoid unexpected changes in behavior.

Note: The API is currently in beta, and the version will remain 1 until the beta phase is over.

Authorization

Authorization is handled using OpenID Connect (OIDC), an open standard and decentralized authentication protocol.

You can find important metadata about our OpenID Connect configuration at the .well-known endpoint: /.well-known/openid-configuration. This endpoint provides details on authorization, token, and user info endpoints, as well as supported authentication methods.

Note: The .well-known endpoint is also subject to change during the beta phase.

API Reference

The API reference provides detailed information about the available endpoints, request parameters, and responses. Using OpenAPI, this section standardizes the description and interaction with our APIs, making it easier to understand and work with them.

Most endpoints require authorization. If you are logged in through the portal, you can use the Swagger interface to explore all available API endpoints, view their descriptions, and perform test calls to ensure they work as expected.

Note: The OpenAPI (Swagger) documentation is currently in beta and subject to changes.