Skip to main content

Intro OpenAPI Documentation

Welcome to our REST API OpenAPI documentation, providing detailed information and specifications for integrating with our services. Our REST API follows the OpenAPI specification, making it easier for developers to understand, interact with, and build upon our API.

Getting Started​

As you may have already read in the intro docs, we have two API gateways and a third special integration:

  • Platform API Gateway
  • Frontend API Gateway
  • Operators Integration

The Platform API Gateway is required to feed our platform and is in charge of connecting your backend services with our platform in order to ingest data using our ingestion API and the reactive API to transmit real-time up-to-the-minute events.

To get started with our Platform API Gateway, you'll need to create an OAuth 2 Client Credentials Grant, which you can create in the provided admin dashboard website. Please check out these docs for more details

The Frontend API Gateway allows your players to authenticate with our platform and use our UI Widgets to display interactive information about Gamification. In order for us to authenticate and validate the player, you as a provider need to implement an API that we need to call to validate the player identity token that is provided by you. Please refer to these docs for more details.

API Reference​

The API reference serves as your comprehensive guide to understanding and utilizing our REST API. It provides detailed descriptions of each endpoint, including its purpose, parameters, request body structure (if applicable), and response format. The reference also indicates which endpoints require authentication and the necessary API Authentication inclusion in the request headers.

In this section you can find our API specification and some API Specifications that you as a operator need to implement, so we can send a request to you.

Please take a look at our API Reference and happy coding!