Overview
This is your partner hub for integrating with YGG Play. Choose only the integrations you need and follow the steps for each.
Prelaunch Assets
Submit required branding and configuration before going live on YGG platforms.
Check the Prelaunch Assets overview to understand what's needed for your integration type.
For Redeem: game name, slug, logo (512×512), thumbnail, point name, points logo, cover image (1920×1080), and reward tiers. See Redeem Assets.
For Quest: quest banner (1920×600), quest card (600×400), title, description, rules, FAQs, and task definitions. See Play Quest Assets.
Share your assets via the #ext-redeem-partnerships Slack channel. YGG will configure your game in the platform.
Quest APIs
Update task statuses and track user progress through quest activities. YGG provides the API; you call it from your game server.
Request your API key from the YGG team during onboarding. This key authenticates all Quest API requests via the apiKey field in request body.
Complete Play Quest Assets: banner, card, title, description, rules, FAQs, and task definitions with externalKey identifiers.
Call POST /activities/task_update/{address} with externalKey, status (completed/rejected), and apiKey. Points are auto-awarded when all tasks complete. See Task Update API.
Test scenarios: task completion with/without points, rejections, invalid keys, duplicate updates. Coordinate go-live with YGG team.
Redeem APIs
Enable point redemptions and $YGG token distribution. You implement API endpoints; YGG calls them.
Generate your X-API-KEY and share it securely with YGG. YGG provides the SHARED_SECRET_KEY for HMAC signature verification. See Authentication.
Complete Redeem Assets: game name, slug, logo, thumbnail, point name, points logo, cover image, reward tiers, and staging/production URLs.
Build 3 required endpoints YGG will call: Get Points (check balance), Deduct Points (remove on redemption), Revert Points (return on failure). Optional: Confirm Redemption.
Verify YGG's request signature: method + path + X-API-REQUEST + stringify(body). Generate response signature for 200 OK responses using same format. See Authentication.
Test all flows in sandbox: get points, deduct, revert, confirm. Validate signature verification. Complete go-live checklist with YGG team.
Staking APIs
Access user staking data for tier-based rewards. YGG provides the API; you call it and verify response signatures.
Request X-API-KEY and SHARED_SECRET_KEY from YGG during onboarding. Store securely in environment variables. See Authentication.
Call GET /api/staking/snapshots?walletAddress={address}&lastDays=7 with X-API-KEY header. Returns 7-day average staked amount. See API Reference.
Verify X-API-SIGNATURE header using method + path + JSON.stringify(responseBody). Reject data if signature is invalid. See Authentication.
Map averageStakedAmount to your game's reward tiers (e.g., Rookie → Ultimate). Apply tier benefits at player login. See Getting Started for tier examples.
Test with various wallet addresses and staking amounts. Handle API failures gracefully (default to lowest tier). Coordinate launch with YGG team.
Connect Abstract
Web3 authentication and wallet connectivity using Abstract Global Wallet.
Start with Abstract Overview and Abstract Global Wallet docs. Also see Connect Abstract for YGG-specific requirements.
Follow Connect to Abstract to set up your dev environment. Get testnet tokens from Faucets.
Use AGW Reusables for customizable wallet components. Implement login flow that captures user's wallet address for YGG APIs.
Test wallet connection, disconnection, and address retrieval. Ensure wallet address is available for Quest, Redeem, and Staking API calls.
Need Help?
Contact Us — Primary support channel: #ext-redeem-partnerships on Slack. Request access during onboarding.