API Testing Guide

This guide provides everything you need to test the GameRamp API in development environment.

Development Credentials

These credentials are for testing only. Never use them in production applications.

{
  "apiKey": "test_tenant_4Dqms3ygG9FVC",
  "apiSecret": "b815ebac-9744-43db-b5e6-89f90620297e-Wjl8qlWrJn2r4OEB7UXJ_L8iYOLTR8p10t83Wi_79Q",
  "tenantId": "test_tenant_1752523421",
  "gameId": "default_game"
}

Quick Start Testing

Step 1: Generate Test Signature

# Generate signature for testing
API_KEY="test_tenant_4Dqms3ygG9FVC"
API_SECRET="b815ebac-9744-43db-b5e6-89f90620297e-Wjl8qlWrJn2r4OEB7UXJ_L8iYOLTR8p10t83Wi_79Q"
DEVICE_ID="device-123"
TIMESTAMP="2025-07-15T19:44:26Z"

# Create payload
PAYLOAD="${API_KEY}|${DEVICE_ID}|${TIMESTAMP}"

# Generate signature (requires openssl)
SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_SECRET" -binary | base64)

echo "Signature: $SIGNATURE"
# Output: /Sn9msNKK4ifTEYrGC/GKpRptolLIyWi4jsfdn5S4g8=

curl -X POST 'https://api.gameramp.com/auth/login' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "test_tenant_4Dqms3ygG9FVC",
    "deviceId": "device-123",
    "timestamp": "2025-07-15T19:44:26Z",
    "signature": "/Sn9msNKK4ifTEYrGC/GKpRptolLIyWi4jsfdn5S4g8="
  }'

Step 3: Use the Token

# Store the access token from login response
ACCESS_TOKEN="eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."

# Use it in API calls
curl -X GET 'https://api.gameramp.com/v1/player/status' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'X-Tenant-Id: test_tenant_1752523421' \
  -H 'X-Game-Id: default_game' \
  -H 'X-Player-Id: test_player_123'

Complete Test Flow

Full API Test Script

#!/bin/bash

# Configuration
API_BASE="https://api.gameramp.com"
API_KEY="test_tenant_4Dqms3ygG9FVC"
API_SECRET="b815ebac-9744-43db-b5e6-89f90620297e-Wjl8qlWrJn2r4OEB7UXJ_L8iYOLTR8p10t83Wi_79Q"
DEVICE_ID="device-$(date +%s)"
TENANT_ID="test_tenant_1752523421"
GAME_ID="default_game"
PLAYER_ID="test_player_123"

echo "🚀 GameRamp API Test Suite"
echo "=========================="

# Step 1: Generate signature
echo "1. Generating signature..."
TIMESTAMP=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
PAYLOAD="${API_KEY}|${DEVICE_ID}|${TIMESTAMP}"
SIGNATURE=$(echo -n "$PAYLOAD" | openssl dgst -sha256 -hmac "$API_SECRET" -binary | base64)
echo "   ✓ Signature generated"

# Step 2: Login
echo "2. Logging in..."
LOGIN_RESPONSE=$(curl -s -X POST "${API_BASE}/auth/login" \
  -H 'Content-Type: application/json' \
  -d "{
    \"apiKey\": \"${API_KEY}\",
    \"deviceId\": \"${DEVICE_ID}\",
    \"timestamp\": \"${TIMESTAMP}\",
    \"signature\": \"${SIGNATURE}\"
  }")

ACCESS_TOKEN=$(echo "$LOGIN_RESPONSE" | jq -r '.accessToken')
REFRESH_TOKEN=$(echo "$LOGIN_RESPONSE" | jq -r '.refreshToken')

if [ "$ACCESS_TOKEN" = "null" ]; then
  echo "   ✗ Login failed"
  echo "$LOGIN_RESPONSE" | jq
  exit 1
fi

echo "   ✓ Login successful"
echo "   Access Token: ${ACCESS_TOKEN:0:50}..."

# Step 3: Get Player Status
echo "3. Getting player status..."
STATUS_RESPONSE=$(curl -s -X GET "${API_BASE}/v1/player/status" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Tenant-Id: $TENANT_ID" \
  -H "X-Game-Id: $GAME_ID" \
  -H "X-Player-Id: $PLAYER_ID")

IS_PAYER=$(echo "$STATUS_RESPONSE" | jq -r '.isPayer.value')
echo "   ✓ Player status retrieved"
echo "   Is Payer: $IS_PAYER"

# Step 4: Get Store Configs
echo "4. Getting store configurations..."
STORE_RESPONSE=$(curl -s -X GET "${API_BASE}/v1/player/store_configs" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Tenant-Id: $TENANT_ID" \
  -H "X-Game-Id: $GAME_ID" \
  -H "X-Player-Id: $PLAYER_ID")

SKU_COUNT=$(echo "$STORE_RESPONSE" | jq '.activeSkus | length')
echo "   ✓ Store configs retrieved"
echo "   Active SKUs: $SKU_COUNT"

# Step 5: Send Events
echo "5. Sending test events..."
EVENT_RESPONSE=$(curl -s -X POST "${API_BASE}/v1/events" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -H "X-Tenant-Id: $TENANT_ID" \
  -d "[
    {
      \"eventType\": \"session_start\",
      \"timestamp\": \"$(date -u +%Y-%m-%dT%H:%M:%S.000Z)\",
      \"payload\": {
        \"userId\": \"$PLAYER_ID\",
        \"sessionId\": \"test-session-$(date +%s)\"
      },
      \"metadata\": {
        \"deviceType\": \"Test Device\",
        \"osName\": \"Test OS\",
        \"osVersion\": \"1.0\"
      }
    }
  ]")

EVENT_STATUS=$(echo "$EVENT_RESPONSE" | jq -r '.status')
if [ "$EVENT_STATUS" = "success" ]; then
  echo "   ✓ Events sent successfully"
else
  echo "   ✗ Event sending failed"
fi

# Step 6: Refresh Token
echo "6. Testing token refresh..."
REFRESH_RESPONSE=$(curl -s -X POST "${API_BASE}/auth/refresh" \
  -H 'Content-Type: application/json' \
  -d "{
    \"refreshToken\": \"${REFRESH_TOKEN}\"
  }")

NEW_ACCESS_TOKEN=$(echo "$REFRESH_RESPONSE" | jq -r '.accessToken')
if [ "$NEW_ACCESS_TOKEN" != "null" ]; then
  echo "   ✓ Token refreshed successfully"
else
  echo "   ✗ Token refresh failed"
fi

# Step 7: Logout
echo "7. Logging out..."
LOGOUT_RESPONSE=$(curl -s -X POST "${API_BASE}/auth/logout" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  -d "{
    \"deviceId\": \"${DEVICE_ID}\"
  }")

echo "   ✓ Logged out"

echo ""
echo "✅ All tests completed!"

Testing Tools

Postman Collection

Import this collection to test APIs in Postman:

{
  "info": {
    "name": "GameRamp API",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{access_token}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.gameramp.com",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "test_tenant_4Dqms3ygG9FVC",
      "type": "string"
    },
    {
      "key": "tenant_id",
      "value": "test_tenant_1752523421",
      "type": "string"
    },
    {
      "key": "game_id",
      "value": "default_game",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Login",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n  \"apiKey\": \"{{api_key}}\",\n  \"deviceId\": \"device-123\",\n  \"timestamp\": \"2025-07-15T19:44:26Z\",\n  \"signature\": \"/Sn9msNKK4ifTEYrGC/GKpRptolLIyWi4jsfdn5S4g8=\"\n}"
        },
        "url": {
          "raw": "{{base_url}}/auth/login",
          "host": ["{{base_url}}"],
          "path": ["auth", "login"]
        }
      }
    }
  ]
}

cURL Examples

Login
Player Status
Store Configs
Send Events

curl -X POST 'https://api.gameramp.com/auth/login' \
  -H 'Content-Type: application/json' \
  -d '{
    "apiKey": "test_tenant_4Dqms3ygG9FVC",
    "deviceId": "device-123",
    "timestamp": "2025-07-15T19:44:26Z",
    "signature": "/Sn9msNKK4ifTEYrGC/GKpRptolLIyWi4jsfdn5S4g8="
  }'

Common Testing Scenarios

Test Player Predictions

// Test different player types
async function testPlayerTypes() {
  const playerIds = [
    'high_value_player',
    'new_player',
    'churned_player',
    'active_f2p_player'
  ];

  for (const playerId of playerIds) {
    const status = await getPlayerStatus(token, tenantId, gameId, playerId);
    console.log(`${playerId}: isPayer = ${status.isPayer.value}`);
  }
}

Test Store Personalization

// Test store configs for different players
async function testStorePersonalization() {
  const players = ['payer_123', 'non_payer_456'];

  for (const playerId of players) {
    const config = await getStoreConfigs(token, tenantId, gameId, playerId);

    console.log(`Player ${playerId}:`);
    console.log(`  SKU Count: ${config.activeSkus.length}`);

    // Check for personalized pricing
    const hasDiscounts = config.activeSkus.some(
      sku => sku.offerPrice < sku.actualPrice
    );
    console.log(`  Has Discounts: ${hasDiscounts}`);
  }
}

Test Event Batching

// Test sending multiple events
async function testEventBatching() {
  const events = [];

  // Generate test events
  for (let i = 0; i < 10; i++) {
    events.push({
      eventType: 'test_event',
      timestamp: new Date().toISOString(),
      payload: {
        eventNumber: i,
        testRun: true
      },
      metadata: {
        batchTest: true
      }
    });
  }

  const response = await sendEvents(token, tenantId, events);
  console.log(`Processed ${response.processed} events`);
}

Debugging Tips

Check Token Expiration

Tokens expire - use the expiresIn field to track expiration

Verify Headers

Ensure all required headers are included in requests

Validate Timestamps

Use UTC timestamps within 5 minutes of server time

Use Logging

Enable verbose logging to debug signature generation

Error Handling

// Comprehensive error handling
async function makeAPICall(endpoint, options) {
  try {
    const response = await fetch(endpoint, options);

    if (!response.ok) {
      switch (response.status) {
        case 401:
          console.error('Authentication failed - check token');
          // Attempt token refresh
          break;
        case 400:
          console.error('Bad request - check parameters');
          break;
        case 404:
          console.error('Resource not found');
          break;
        case 500:
          console.error('Server error - retry later');
          break;
        default:
          console.error(`Unexpected status: ${response.status}`);
      }

      const error = await response.text();
      console.error('Error details:', error);
      throw new Error(`API call failed: ${response.status}`);
    }

    return response.json();
  } catch (error) {
    console.error('Network error:', error);
    throw error;
  }
}

Next Steps

API Reference

Complete API documentation

Unity SDK

Integrate with Unity

Authentication

Learn about authentication

Support

Get help from our team

Getting Started

Authentication

Events

Player

​API Testing Guide

​Development Credentials

​Quick Start Testing

​Step 1: Generate Test Signature

​Step 2: Login and Get Token

​Step 3: Use the Token

​Complete Test Flow

​Full API Test Script

​Testing Tools

​Postman Collection

​cURL Examples

​Common Testing Scenarios

​Test Player Predictions

​Test Store Personalization

​Test Event Batching

​Debugging Tips

​Error Handling

​Next Steps

API Reference

Unity SDK

Authentication

Support

API Testing Guide

Development Credentials

Quick Start Testing

Step 1: Generate Test Signature

Step 2: Login and Get Token

Step 3: Use the Token

Complete Test Flow

Full API Test Script

Testing Tools

Postman Collection

cURL Examples

Common Testing Scenarios

Test Player Predictions

Test Store Personalization

Test Event Batching

Debugging Tips

Error Handling

Next Steps