Quest APIs Overview
🎮
Base URL: https://api.example.com/api/v1 (Replace with your actual endpoint)
Available APIs
Overview
The Quest APIs allow partners to interact with YGG's quest and activity system. These APIs enable you to update task statuses and track user progress through various activities.
Key Features
- Task Status Updates: Mark tasks as completed or rejected
- Automatic Point Awards: Points are automatically awarded when all tasks in an activity are completed
- Transaction Tracking: Receive transaction details when points are awarded
Authentication
All Quest API requests require authentication using an API key:
| Header | Description | Example |
|---|---|---|
apiKey | Partner API key for authentication | partner_api_testing |
🔐
Security: Keep your API key secure and never expose it in client-side code.
Response Format
All APIs return JSON responses with appropriate HTTP status codes:
- 200 OK: Successful operation
- 400 Bad Request: Partner validation failed
- 401 Unauthorized: Invalid API key or authentication failed
- 404 Not Found: Resource not found
- 409 Conflict: Task status conflict or constraint violation
- 500 Internal Server Error: Server error occurred