Skip to main content

Players Data Load

The CRM depends on a minimum of information from the player for its correct operation.

The PEP Players Data Module is in charge of storing all that information to be consumed by the different services of the platform. Also, every event that updates the player’s data; triggers events to the service that depends on this data. For this reason, it is necessary to migrate for the first time all the minimum information of the players; this will be necessary only once since later it will be updated through endpoints when the user executes some action, such as registration, data update, and so on.

It is necessary that the Casino sends us the players' information through the endpoint enabled in the Platform API Gateway.

Players Migration, First Load & Offline Sync​

PEP offers an API designed for the first data load of players data, this API is designed to work for the following use cases:

  • First Platform Data Load: The initial process of importing large volumes of data into a platform when it is first set up or when transitioning from an old system. This ensures that all necessary data is available for use by the platform’s features.
  • Migrate Data: The process of transferring data from one system or database to another, often as part of system upgrades, consolidations, or platform changes. It includes data extraction, transformation, and loading (ETL) to ensure consistency and integrity.
  • Offline Sync: A mechanism that allows data to be collected or modified while not connected to the internet, which is later synchronized with the central server once the device is online, ensuring data consistency across platforms.
tip

The API Specification to send the players Chunk is defined here: Players Migration

This API returns the Task ID related to the chunk load background process.

Chunk Size​

The recommended chunk size is 20,000 players. This value can vary. The request body must not exceed 15 MB in size.

When this piece of players is received, they will be validated and a response object will be sent with the players that were validated correctly, and those that were not, errors will be sent with their respective property names. The players that were validated correctly will start processing in the background and will be saved in the database.

Compression​

To reduce data size and accelerate data transfer, the data must be compressed using Gzip or Brotli. The Content-Encoding header is specified in the request:

  • Accept-Encoding: gzip
  • Accept-Encoding: br

Players Migration Feedback (Streamed)​

Once our platform finish processing any single Chunk, you can fetch the status or error details to validate if the process finished correctly.

This API returns the error details after the migration task execution. This call returns a list of players with specific details of the errors detected during the migration process, for example, DTO validations, format, and general errors that are not compliant with the Gamanza Player Engagement platform player data schemas. The response body content encoding is gzip.

tip

The API Specification check the status of a Migration Task is described here: Players Migration Feedback

This API returns a streamed JSON with the migration detail.