Welcome to Tribally Public API
The Tribally Public API provides a suite of APIs designed to help developers integrate their games and applications seamlessly with the Tribally platform. It offers secure authentication, user profile management, quest tracking, and structured activity logging to enhance player engagement and game data management.
Table of Contents
- Introduction
- Available APIs
- Authentication
- Error Handling
- Creating an Application
- Example Application
- Partner Portal
Introduction
The Tribally Public API is a set of public APIs that enables developers to connect their games to the Tribally ecosystem. It provides the necessary tools to authenticate users, track in-game progress, and manage player data while ensuring security and reliability.
The Public API is built with flexibility in mind, allowing partners to retrieve user information, submit game-related activities, and access live quests without friction.
Available APIs
The Public API includes multiple APIs tailored for different aspects of game integration:
- Membership API: Provides user authentication and profile data, allowing applications to retrieve player information securely.
- Quest API: Enables developers to track in-game quests, view active challenges, and manage quest-related rewards.
- Activity API: Allows partners to submit structured game activity data, helping record in-game events and interactions.
Authentication
All APIs within the Public API require authentication. Depending on the endpoint, authentication is handled using:
- OAuth Authentication: Used for endpoints that require user-level authorization. Include the Bearer token in the
Authorization
header. - API Key Authentication: Used for partner-level access to public APIs. Include the API key in the
x-api-key
header.
Creating an Application
To create your first application, sign up for the Tribally Partner Portal. After logging in, go to the Applications page and click Create Application to generate your API key.
Example Application
The Tribally Maze Game showcases various API integrations:
- Authentication via Public Membership API : Users can quickly & easily connect their Tribally account to their gaming account
- Tribally Profile via Public Membership API: The user experience is customized with user profile pictures & display names from their Tribally profiles
- Quests via Public Quest API: Users can track their Tribally quests directly within the game interface
- Activities via Public Activity API: Game activities are sent to Tribally so that users can complete quests and earn rewards
Partner Portal
Use the Tribally Partner Portal to create and manage applications built with the Tribally DevKit. Need help getting started or have feedback? Reach out to us on Slack — we’d love to hear from you.