Skip to main content

Internal APIs

The Internal APIs provide server-to-server communication between the Tournament System and Game Platform. These APIs enable tournament configuration retrieval, player list access, status monitoring, and tournament creation for hop-on/off formats.

Authentication

All internal APIs require authentication via internal API keys in the Authorization header:
Internal API Keys are high-privilege keys intended only for secure server-to-server communication. Never expose these keys in client-side code or public repositories.

Tournament Configuration APIs

Get Tournament Configuration

Retrieve complete tournament configuration for game room setup:
Response:

Get Tournament Status

Monitor real-time tournament status and progress:
Response:

Tournament Status Values

Player Management APIs

Get Tournament Players

Retrieve list of registered players for tournament setup:
Query Parameters:
  • status - Filter by player status (active, registered, eliminated)
  • includeEliminated - Include eliminated players (default: false)
  • limit - Results per page (default: 100, max: 500)
Response:

Tournament Creation APIs (Hop-on/Off Only)

Create Tournament

Create on-demand tournament for hop-on/off format:
Response:

Remove Player (Hop-on/Off Only)

Remove player from tournament before start with refund:
Response:

Integration Examples

Tournament Configuration Flow

Hop-on/Off Tournament Creation

Tournament Status Monitoring

Error Handling

Common Error Responses

Tournament Not Found

Invalid Internal API Key

Tournament Not Ready

Error Handling Best Practices

Retry Logic

Implement exponential backoff for failed requests with circuit breaker patterns

Status Validation

Always validate tournament status before attempting operations

Graceful Degradation

Handle API failures gracefully without breaking game functionality

Monitoring

Monitor internal API response times and error rates

Rate Limits

Internal APIs have higher rate limits than external APIs:

Next Steps

JWT Authentication

Learn how to validate player JWT tokens for game access.

Event Reporting

Report tournament events via SQS for external notifications.