Game.tv (https://www.game.tv/) is, at its core, a mobile esports platform. While there are a lot of other esports platforms out there, what differentiates us from most others is the seamless tournament experience that we offer to our users - both players and hosts. This is, in a large part, because of the relationships we have with game developers and the game integrations we are able to set up.
The process of adding a new game usually starts with us sharing an API document with a game developer. The document may have some APIs that we will create and the developer will call, and some that the developer will create and we will call at certain times in the tournament workflow.
A typical tournament workflow looks like this:
- A tournament host creates a tournament
- Users register for the tournament.
- At tournament time, brackets are created and players are told about their matches.
- At match time, players are asked to play their game.
- Once a match ends, its results are updated.
- If a player wins their match, they advance in the tournament, and if they lose, they are out of the tournament.
Some of the steps necessarily need to involve the game that the tournament is for, while some of them can be taken care of by the game.tv app itself. The goal of the game integration is that tournaments run seamlessly for both the players and tournament hosts so they don’t have to do anything manually.
We need you to prepare an API document that we can share with a game developer to support such a workflow. It would help to have a flowchart and/or sequence diagram as well.
Note: Please don’t try to create APIs to replicate the above workflow verbatim. We are more interested in the pieces that involve the game and what we can do there. Example: when a tournament ends, we might call an api provided by the game developer to send in-game rewards to the winners.
Bonus:
- Design a system diagram for how this integration would work at scale
- Prepare the API document using a tool like Swagger or Slate