API Reference

🔗

Base URL: https://partner-api.example.com (Replace with your actual endpoint)

Required APIs

These APIs must be implemented by all game partners:

⚠️

Important: All APIs should return HTTP Status 200 OK as a successful response and use the success field to indicate the actual result.

{
  "success": true,
  // ... additional required fields
}

{
  "success": false,
  "errorCode": "ERR-XX",
  "errorMessage": "Description of what went wrong"
}

All API requests from YGG will include these headers:

🔐

See Authentication for detailed HMAC signature implementation.

🔑

Critical: For 200 OK responses, you MUST include X-API-SIGNATURE in response headers.

Response Type	Headers Required	Notes
`200 OK` Success	✅ `X-API-SIGNATURE`	Generate signature using response body
Error Responses	❌ No signature	4xx and 5xx responses don't need signatures