Skip to main content

Documentation Index

Fetch the complete documentation index at: https://playcamp.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Test API integration without creating actual data.
When calling with isTest: true, request parameter validation is performed identically to production, but data is not saved to the database.

​
Usage

POST requests: Add isTest: true to the request body. 
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
  }'
Recommended: Verify integration in Sandbox environment with isTest: true before campaign launch, then remove the isTest parameter for actual campaign operation.
GET requests: Add isTest=true as a query parameter. 
curl "https://sandbox-sdk-api.playcamp.io/v1/server/campaigns?isTest=true" \
  -H "Authorization: Bearer ak_server_xxx:secret"

​
Supported APIs

​
Server API (Write)

APIisTest Support
POST /sponsorsYes (body)
DELETE /sponsors/user/:userIdYes (query)
POST /paymentsYes (body)
POST /payments/:id/refundYes (body)
POST /coupons/validateYes (body)
POST /coupons/redeemYes (body)

​
Server API (Read)

APIisTest Support
GET /campaignsYes (query)
GET /campaigns/:idYes (query)
GET /campaigns/:id/creatorsYes (query)
GET /creators/searchYes (query)
GET /creators/:creatorKeyYes (query)

​
Client API (Read)

APIisTest Support
GET /campaignsYes (query)
GET /campaigns/:idYes (query)
GET /campaigns/:id/creatorsYes (query)
GET /campaigns/:id/packagesYes (query)
GET /creators/searchYes (query)
GET /creators/:creatorKeyYes (query)
GET /sponsorsYes (query)

​
Integration Completion

To complete integration with PlayCamp, at least one API call is required for each category.
Requests using the isTest: true flag also count toward integration completion.
CategoryRequired API (call at least 1)
Boost (Sponsor)POST /v1/server/sponsors
PaymentPOST /v1/server/payments
CouponPOST /v1/server/coupons/validate or POST /v1/server/coupons/redeem
All category integrations must be completed to properly operate campaigns.