Endpoints

TPP Endpoints

What is an Endpoint?

An endpoint is a specific URL in the TPP API that allows you to access particular resources or perform specific actions in the gifting program system. Each endpoint represents a specific functionality within the TPP ecosystem.

TPP System Architecture

The TPP API is designed as a complete ecosystem for iGaming gifting programs, organized into 11 main modules that work together:

🏢 1. Establishments

  • Purpose: Configuration and management of casinos/betting houses
  • Features: Branding, visual configuration, virtual currencies, localization
  • Key endpoints: GET/PUT /establishments/{establishmentId}

👥 2. Players

  • Purpose: Complete player management and profiles
  • Features: Registration, updates, deletion, tournament positions
  • Key endpoints: GET/POST/PUT/DELETE /players, /players/{playerId}

🎁 3. Products

  • Purpose: Catalog of available physical and digital prizes
  • Features: Inventory management, pricing, categories, stock
  • Key endpoints: GET/POST /products

🛒 4. Orders

  • Purpose: Complete order and shipping management system
  • Features: Reservations, shipping, tracking, acquisitions
  • Key endpoints: POST /orders/{playerId}/reservation, /orders/{playerId}/send/{transactionId}

🎯 5. Campaigns

  • Purpose: Creation and management of promotional campaigns
  • Features: Daily rewards, tournaments, targeting, budgets
  • Key endpoints: GET/POST /establishments/{establishmentId}/campaigns

📚 6. Catalogs

  • Purpose: Organization of products into thematic collections
  • Features: Catalog creation, product management, categorization
  • Key endpoints: GET/POST/PUT/DELETE /establishments/{establishmentId}/catalogs

🪙 7. Coins

  • Purpose: Virtual currency and points system
  • Features: Balance adjustments, add/subtract operations, campaign linking
  • Key endpoints: PUT /coins

🏆 8. Prizes

  • Purpose: Prize claiming system
  • Features: Coin or product claiming, address management
  • Key endpoints: POST /players/{playerId}/claim

🎮 9. Games

  • Purpose: Integration with minigames and campaigns
  • Features: Game configuration, game state
  • Key endpoints: GET /players/{playerId}/game/{gameName}/{campaignId}

📦 10. Order Interactions

  • Purpose: Advanced order lifecycle management
  • Features: Reservations, cancellations, acquisitions, tracking
  • Key endpoints: POST/DELETE /orders/{playerId}/reservation/{transactionId}

🖼️ 11. Iframe

  • Purpose: Iframe integration for marketplaces
  • Features: Player authentication, session tokens
  • Key endpoints: POST /iframe/login

Typical Workflow

1. Initial Setup

Establishment → Branding and currency configuration

2. Player Management

Player registration → Coin allocation → Activity tracking

3. Campaigns and Prizes

Campaign creation → Product assignment → Coin distribution

4. Order Process

Reservation → Shipping → Tracking → Acquisition

5. Integration

Iframe → Authentication → Marketplace → Prize claiming

Technical Features

Supported HTTP Methods

  • GET: Retrieve data
  • POST: Create new resources
  • PUT: Update existing resources
  • DELETE: Delete resources

Authentication

  • API key system
  • Session tokens for iframe
  • Establishment-based authentication

Response Format

  • JSON for all responses
  • Standard HTTP status codes
  • Descriptive error messages

Rate Limiting

  • Rate limits per endpoint
  • Custom allocations per account
  • Performance optimization

Main Use Cases

For Casino Operators

  1. Configure establishment with custom branding
  2. Create campaigns with specific prizes
  3. Manage inventory of products and catalogs
  4. Monitor orders and shipments in real-time

For Developers

  1. Integrate iframe into existing platforms
  2. Sync players with internal systems
  3. Automate campaigns based on behavior
  4. Implement custom minigames

For Players

  1. Access marketplace through iframe
  2. Claim prizes physical and digital
  3. Participate in campaigns and tournaments
  4. Track orders in real-time

Endpoint Navigation

Detailed Documentation

The TPP API is designed to be intuitive, scalable, and easy to integrate. Each endpoint is optimized for specific use cases in the iGaming gifting program ecosystem.

WorkflowCoins