Introduction
This section is intended for developers who want to understand the technical aspects of the QyroLabs ecosystem and explore potential integration opportunities.
The available documentation should reflect the actual systems, interfaces, and integration methods supported by the platform.
Game Integration
Game integration documentation should explain how a supported game interacts with QyroLabs.
Depending on the actual implementation, this may include:
- Player identification.
- Account association.
- XP reporting.
- Badge-related events.
- Error handling.
- Integration testing.
Specific implementation instructions should only be published after the relevant interfaces have been verified.
Authentication
Authentication documentation should explain the supported login flow and any integration requirements that apply to authorized developers.
Never publish private credentials, authentication secrets, signing keys, or other sensitive configuration values.
Gaming ID Integration
Where cross-game integration is supported, developer documentation should explain how a player’s Gaming ID is obtained, validated, and used by participating games.
The exact process must follow the implementation provided by QyroLabs.
XP Integration
If a game can report XP to QyroLabs, its integration documentation should describe the supported reporting process, validation requirements, and handling of duplicate or invalid events.
XP should only be credited through authorized and verified mechanisms.
API Reference
An API reference should document the endpoints that actually exist and are approved for external use.
Each endpoint entry should include:
- Purpose.
- HTTP method.
- Request format.
- Authentication requirements.
- Parameters.
- Response format.
- Error responses.
- Rate limits, where applicable.
Do not publish invented endpoints or example responses that could be mistaken for working production APIs.
Developer Support
Developers should use the official support channels provided by QyroLabs for integration questions and technical issues.
When reporting an issue, include the relevant integration details without exposing secrets or private user information.