Intro

The Player Engagement Platform (PEP) is a crucial tool for online gaming operators to manage their player base, improve customer retention, and increase revenue by providing personalized, relevant, and engaging experiences to their players.

The Gamanza PEP integrates with other systems such as the gaming platform, player account management system, and marketing tools, enabling operators to streamline their operations and improve the overall customer experience. The platform also provides detailed analytics and reports that allow operators to track the effectiveness of their marketing campaigns and make data-driven decisions to optimize their business performance.

The PEP tracks player activity in real time*, providing operators with insights into player behavior and preferences. This information can be used to develop customized rewards programs, VIP schemes, segmentation, and other incentives that keep players engaged and motivated to continue playing on the gaming site.

Getting Started

The PEP provides two API Gateways designed for specific use cases and security levels:

1. Platform API Gateway: Designed to provide integration between the operators platform and the PEP.
2. Frontend API Gateway: Designed to provide integration with the casino or operators frontend application, it is used to retrieve player information for the gamification and loyalty system integrations. Requires player specific API access.

Platform Integration

The PEP is a system based on reactive data streaming, this means that the system is designed to operate and make decisions based on up-to-the-minute data, that is transmitted and processed in a reactive manner, as it is generated. The platform API Gateway provides integration between the operators platform and the PEP, exposing APIs to allow data ingestion and real-time/reactive data feeds. In order to ensure reactive triggering of activities and keep the segmentation model up to date, it is necessary to publish registration, transactional and login events to the integration platform within the operators system. Providing an API for data ingestion involves creating a set of endpoints that can receive and process incoming data, mostly used for first data load/sync.

What are data ingestion APIs? They are APIs designed for bulk data operations like first data load or periodic data sync between the operators platform and PEP, and sync operations. Some common uses are:

• Bulk player data sync
• Sending messages to players (email, sms, push notifications)
• Requesting information from the CRM

What are reactive APIs? They are APIs used to feed real time events that should be processed immediately and are going to trigger internal processes like:

• Gamification: start the decision engine to validate missions assigned for the player, move ranks and points.
• Segmentation: keep the segmentation model up to date, and provide transactional aggregations
• CRM: send trigger campaigns related to transactional events.

Authentication: The Authentication method required for platform integrations is OAuth 2.0 using grant type client_credentials. The Client Credentials grant is used when applications request an access token to access their own resources, not on behalf of a user.

Operators Frontend Integration

Some of the features provided by the PEP require integration with the end user (player), to provide all the gamification interactions for custom components or the PEP built-in provided UI Widgets. These API Gateways provide integration with RestAPI to retrieve information related to the player missions progress, bundles, tournaments, ranks, etc and SocketIO to provide real-time updates according to the Player progress as well as provide integration with CRM communication features like On Site notifications, Push Notifications and much more future integrations.

In order to provide Authentication to the Casino FE clients (aka players), we require an identity JWT to properly secure the player request to the Frontend API Gateway.

In order to validate the Player Session, and create the JWT Identity Token for the player to access the PEP FE endpoints, the Operators need to provide a valid player SessionID or Identity Token that is validated by the PEP with the Operators API.

No matter which mechanism you use to authenticate the Player in your CasinoUI, we need to generate a valid Identity Access Token to allow your player to connect with the PEP Player API endpoints.

Player Auth Process:

1. You need to call the POST: {gamanza_engage_fe_api_url}/api/auth/v1/player endpoint with the following parameters:

• identityToken: string : Unique player identity token like sessionID or accessToken
• clientId: string: ClientID generated in the Admin related to your API client.

2. The PEP Frontend API Gateway receives the call and immediately calls an endpoint in the Operators API to validate the Identity Token. This API should be implemented as follows:

• Method: POST

• Endpoint: {operators_api_url}/api/auth/v1/player

• Params:

  • identityToken: string

• Returns:

  • status: 200
  • Payload (JSON):
    • playerId: <string|required> the player id related to the identity token.
    • expiresAt: <RFC 3339 format DateTime|optional> datetime until the Player Identity token is valid.

• Errors:

  • 404: Not found
  • 400: Invalid parameter
  • 401: Token Invalid or expired
  • 500: Internal Server Error

3. Once the PEP receives the PlayerID, a new JWT Identity Token is created to allow the Player to access the PEP API, by adding the JWT in the x-authorization header.

Process Flow:

tip

If you are using the Gamanza Engage UI Widgets, the authentication process is handled internally, so you don't need to worry about the authentication process; but it is mandatory to provide the Identity Token for the player.

tip

For more details check the Open API Specification here.

Player Validate Identity Token API Spec