Skip to main content

Getting Started

Welcome to the SplitScreen API! This guide will help you understand the complete workflow for integrating with our matchmaking platform.

Early Access Program​

We're currently inviting developers to our staging environment for early access. You can try SplitScreen now at https://splitscreen-staging.shonen.network. If you'd like our support while you test, please fill out our Early Access Application Form.

Overview​

The SplitScreen API provides intelligent matchmaking for your gaming platform. The integration process consists of three main steps:

  1. Client Registration & Authentication - Register your application and get access credentials
  2. Upload Users - Add your users to the platform for matchmaking
  3. Get Recommendations - Retrieve personalized matchmaking suggestions

Quick Start Workflow​

Step 1: Register Your Client​

First, you'll need to register your application with the SplitScreen API to get your credentials.

curl -X POST https://api.splitscreen-example.com/v1/client \
  -H "Content-Type: application/json" \
  -d '{"name": "My Awesome Game"}'

This will give you a client_id, api_key, and client_secret that you'll use for authentication.

Step 2: Get Access Token​

Use your credentials to obtain a JWT access token:

curl -X POST https://api.splitscreen-example.com/v1/token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "your-client-id",
    "api_key": "your-api-key",
    "client_secret": "your-client-secret"
  }'

Step 3: Upload Your Users​

Add your users to the platform for matchmaking:

curl -X POST https://api.splitscreen-example.com/v1/import/users \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "client_user_id": "user123",
      "username": "PlayerOne",
      "profile_data": {
        "preferences": {"game_types": ["fps", "strategy"]}
      }
    }
  ]'

Step 4: Get Recommendations​

Retrieve personalized matchmaking suggestions:

curl -X GET "https://api.splitscreen-example.com/v1/users/user123/recommendations?count=5" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Detailed Guides​

For comprehensive information about each step, check out our detailed guides:

What's Next?​

Once you've completed the basic integration:

  • Explore the API Reference for detailed endpoint documentation
  • Learn about the Architecture to understand how the system works
  • Check out our testing guide for examples and best practices

Need Help?​

If you run into any issues during integration:

  • Check our API Reference for detailed endpoint information
  • Review the Architecture documentation to understand the system
  • Contact our support team for assistance

Happy matchmaking! 🎮