The partner API can be used to integrate bingo 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’s use can be done using the API.

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

Steps:

• Request a Partner API account (ask @Jens de Ruiter)
  • Using the Partner API should have some kind of mutual benefit. This is something we can discuss
  • We need to know the IP addresses of the proxies from which you want to send players, and set a quote for the amount of servers you can use at the same time
• Implement the API into your server proxy software
• Happy bingo!

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. Use https://privategame.bingomc.net/api/partner as a the base API URL.

A server’s state can have one of three values:

• WAITING - the server is waiting and can accept players into its lobby
• RUNNING - the server has an active game and will not allow new players (players get accepted as a spectator)
• DONE - the server will be removed soon. This happens when the game is done, or if the server gets removed

Connecting to a server

Connecting to a server should be as easy as adding the ip + 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 to ‘legacy’.