Overview

Architecture

PlayCamp SDK API is integrated through the game server.

Role Distribution

Component	Role
Game Client	User interface (creator selection UI, coupon input screen, etc.)
Game Server	API calls, business logic processing, Server Key storage
PlayCamp SDK API	Data storage, settlement calculation, statistics aggregation, webhook delivery

Data Flow Example

Creator Selection

User selects a creator in the game

Boost Registration

Game server calls POST /v1/server/sponsors

In-game Payment

User makes an in-game payment

Payment Registration

Game server calls POST /v1/server/payments

Auto Attribution

SDK API automatically attributes the payment to the creator

Settlement

Creator revenue is calculated at end of month settlement

Getting Started

Required Integration APIs

Three Server APIs that must be integrated for campaign operation:

Function	API	Description
Create Boost	`POST /sponsors`	User boosts a creator. Core for payment attribution
Validate Coupon	`POST /coupons/validate`	Validate coupon code
Create Payment	`POST /payments`	Register in-game payment. Base data for settlement

Integration verification required for campaign publishing. Each of the 3 APIs above must be called at least once on the Live environment before your campaign can be published. Without this, the campaign approval screen will show:“Game is not linked with PlayCamp. API integration required.”You can use isTest: true for these verification calls — test mode requests count toward integration verification while not saving any actual data.

Integration verification flow:

Integrate APIs

Implement the 3 required APIs in your game server

Call each API on Live

Make at least one request per API to the Live environment (https://sdk-api.playcamp.io). Using isTest: true is allowed.

Request campaign approval

Once all 3 APIs have been verified, request approval from the PlayCamp admin

Campaign published

After approval, the integration warning disappears and the campaign moves to published status

Campaign/Creator queries and webhooks can be integrated optionally.

API Key Issuance

Create a project on the PlayCamp platform to receive API keys.

Key Type	Purpose	Storage Location
Server Key	All API calls (read/write)	Game server (store securely)
Client Key	Query APIs only (read-only)	Game client (optional use)

Never expose Server Key to the client.

Authentication

All API requests use Bearer Token authentication.

Authorization: Bearer {keyId}:{secret}

Example:

Authorization: Bearer ak_server_abc123def456:xyz789secretkey

Server Environments

Environment	URL	Purpose
Sandbox	`https://sandbox-sdk-api.playcamp.io`	Development/Testing
Live	`https://sdk-api.playcamp.io`	Production

Use the Sandbox environment during development. Sandbox is completely isolated from Live.

Integration Flow

POST /sponsors          → User selects creator (boost)
POST /coupons/validate  → Validate coupon code
POST /payments          → Register when in-game payment occurs

SDKs

For type-safe integration, use the official SDKs instead of raw HTTP calls:

Node SDK
Go SDK

npm install @playcamp/node-sdk

import { PlayCampServer } from '@playcamp/node-sdk';

const server = new PlayCampServer('your_server_key:your_secret', {
  environment: 'sandbox',
});

See the Node SDK guide for full documentation.

go get github.com/playcamp/playcamp-go-sdk

import playcamp "github.com/playcamp/playcamp-go-sdk"

server, err := playcamp.NewServer("your_server_key:your_secret",
    playcamp.WithEnvironment(playcamp.EnvironmentSandbox),
)

See the Go SDK guide for full documentation.

Test Mode

Before campaign launch, use isTest: true parameter to test API integration.

cURL
Node SDK
Go SDK

curl -X POST "https://sandbox-sdk-api.playcamp.io/v1/server/payments" \
  -H "Authorization: Bearer ak_server_xxx:secret" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "test_user",
    "transactionId": "test_txn_001",
    "productId": "gem_pack_100",
    "amount": 9900,
    "currency": "KRW",
    "platform": "Android",
    "distributionType": "MOBILE_STORE",
    "purchasedAt": "2024-01-15T10:30:00.000Z",
    "isTest": true
  }'

const server = new PlayCampServer('your_server_key:your_secret', {
  environment: 'sandbox',
  isTest: true,
});

const payment = await server.payments.create({
  userId: 'test_user',
  transactionId: 'test_txn_001',
  productId: 'gem_pack_100',
  amount: 9900,
  currency: 'KRW',
  platform: 'Android',
  distributionType: 'MOBILE_STORE',
  purchasedAt: new Date('2024-01-15T10:30:00Z'),
});

server, _ := playcamp.NewServer("your_server_key:your_secret",
    playcamp.WithEnvironment(playcamp.EnvironmentSandbox),
    playcamp.WithTestMode(true),
)

purchasedAt, _ := time.Parse(time.RFC3339, "2024-01-15T10:30:00Z")

payment, err := server.Payments.Create(ctx, playcamp.CreatePaymentParams{
    UserID:           "test_user",
    TransactionID:    "test_txn_001",
    ProductID:        "gem_pack_100",
    Amount:           9900,
    Currency:         "KRW",
    Platform:         playcamp.PaymentPlatformAndroid,
    DistributionType: playcamp.String("MOBILE_STORE"),
    PurchasedAt:      purchasedAt,
})

Test Mode Features:

Request parameter validation is performed identically to production
Data is not saved to DB
Returns mock response

Recommended: Use isTest: true when integrating before campaign launch. isTest can be used in both Sandbox and Live environments. Remove the isTest parameter for actual campaign operation.

See Test Mode for more details.

Platform

For Developers

For Creators

Architecture

Role Distribution

Data Flow Example

Getting Started

Required Integration APIs

API Key Issuance

Authentication

Server Environments

Integration Flow

SDKs

Test Mode

​Architecture

​Role Distribution

​Data Flow Example

​Getting Started

​Required Integration APIs

​API Key Issuance

​Authentication

​Server Environments

​Integration Flow

​SDKs

​Test Mode

Architecture

Role Distribution

Data Flow Example

Getting Started

Required Integration APIs

API Key Issuance

Authentication

Server Environments

Integration Flow

SDKs

Test Mode