Skip to main content

​
GameRamp API Documentation

The GameRamp API provides programmatic access to track player events and retrieve personalized configurations and predictions.

​
Base URL

All API requests should be made to: 
https://api.gameramp.com

​
Key Features

Event Tracking

Send click-stream events and player behavior data

Player Predictions

Get AI-powered player predictions and segments

Store Configs

Retrieve personalized store configurations

JWT Authentication

Secure authentication with signed requests

​
API Categories

​
Authentication APIs

APIs for managing authentication and tokens:
  • Login - Authenticate and obtain JWT tokens
  • Refresh Token - Refresh expired access tokens
  • Logout - Invalidate active tokens

​
Data Transfer APIs

APIs for sending data to GameRamp:
  • Events - Track player events and behaviors

​
Configuration APIs

APIs for retrieving predictions and configurations:

​
Authentication

All API endpoints require authentication using JWT tokens obtained through the login endpoint.
1

Obtain Credentials

Get your API Key and Secret from GameRamp
2

Generate Signature

Create HMAC-SHA256 signature with your Secret
3

Login

Exchange signature for JWT tokens
4

Make API Calls

Use JWT token in Authorization header

​
Quick Start

curl -X POST 'https://api.gameramp.com/auth/login' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "your_api_key",
    "deviceId": "unique_device_id",
    "timestamp": "2025-01-15T10:00:00Z",
    "signature": "base64_encoded_signature"
  }'

​
Response Format

All API responses follow a consistent JSON format:

​
Success Response

{
  "data": { ... },
  "status": "success"
}

​
Error Response

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Human readable error message"
  },
  "status": "error"
}

​
Development Environment

For testing and development, use these credentials:
These are test credentials only. Never use them in production.
{
  "apiKey": "test_tenant_4Dqms3ygG9FVC",
  "apiSecret": "b815ebac-9744-43db-b5e6-89f90620297e-Wjl8qlWrJn2r4OEB7UXJ_L8iYOLTR8p10t83Wi_79Q"
}

​
SDK Support

For easier integration, use our official SDKs:

Unity SDK

Complete Unity integration with prefab support

Coming Soon

More SDKs in development

​
Need Help?

Contact Support

Our team is here to help with your API integration