Partner API

The Partner API can be used to integrate BingoMC multiplayer games into your own server. It allows you to use a quota of the network's games for your own server. Requesting a bingo game for your server can be done through the API.

Bingo games can be customized to fit your needs. Custom game options, cards, branding, and connection addresses can all be implemented.

Getting Started

• Request a Partner API account by contacting BingoMC. Using the Partner API should have some kind of mutual benefit, which we can discuss.
• Provide the IP addresses of the proxies from which you want to send players, and agree on a quota for the amount of servers you can use at the same time.
• Implement the API into your server proxy software. A free Velocity integration is available from the BingoMC team.
• Start sending players into bingo games.

The API

A basic REST API is available to create and remove servers. Authenticate every request with the API key as the Api-Key header.

Server States

• WAITING: the server is waiting and can accept players into its lobby.
• RUNNING: the server has an active game and new players are accepted as spectators.
• DONE: the server will be removed soon after the game is done or after removal is requested.

Connecting To A Server

Connecting to a server should be as easy as adding the IP and port to your Minecraft server proxy software. You should handle sending players to the server yourself.

BungeeCord users should turn IP forwarding on. Velocity users should set their forwarding mode to legacy.

{
  "name": "your_account",
  "servers_available": 1,
  "servers_total": 2
}

[
  {
    "id": 1234,
    "state": "RUNNING",
    "players": 3,
    "ip": "10.0.0.1",
    "port": 25565
  },
  {
    "id": 4321,
    "state": "WAITING",
    "players": 0,
    "ip": "10.0.0.2",
    "port": 25566
  }
]

{
  "id": 4321,
  "state": "WAITING",
  "players": 0,
  "ip": "10.0.0.2",
  "port": 25566
}