Pular para o conteúdo principal

Platform REST API

REST endpoints on the Platform API Gateway for managing player data in the Gamanza Engage Platform (PEP). Use these for bulk and management operations — creating and updating players, managing custom data and tags, handling player deletion, bulk migration, reading CRM templates, and setting responsible-gaming risk flags. They complement the reactive event APIs, which stream real-time events into the platform.

Every request requires an OAuth 2.0 access token — see Platform API Auth for how to obtain one. Each API below has its own Introduction page with an Export button to download its OpenAPI spec.

APIs

  • Players Integration — create and update players, and manage the custom data fields (metadata and allowed options) used for segmentation and templating.
  • Player Tags — create, assign, and remove player tags and tag categories used to segment and target players.
  • Player Deletion — delete a player, cancel a pending hard deletion within the 48-hour window, or restore a deleted player.
  • Players Migration — bulk-migrate players (first data load) and retrieve error details for a migration task.
  • CRM Message Gateway Templates — read the CRM message templates configured in PEP, to reference when triggering campaigns or direct content.
  • Risk — manage responsible-gaming risk flags: list, add, or remove a player's risk status.
dica

For the OAuth onboarding walkthrough and instance setup, see the Integration Process guide.