Skip to content
English
Contact us
  • There are no suggestions because the search field is empty.

API (Application Programming Interface) Access & Usage

Our system can be managed through a user-friendly website interface, but, it also provides API access for advanced integrations.

What is an API?

API stands for Application Programming Interface. In simple terms, it is a structured way for different software systems to communicate with each other.

With API access, other applications or systems - such as your own software, dashboards, or booking tools - can interact with our system without needing to use the website manually.

This allows for actions such as retrieving system status, changing settings, or triggering specific functions (like switching games) to be performed programmatically. APIs are commonly used when businesses want to integrate systems into their existing workflows or automate certain tasks.

It is important to note that using our API is entirely optional. The standard admin website interface remains fully functional and suitable for most users. However, for those who require more advanced or automated control, the API offers a powerful and flexible solution.

If your team or technical partner would like to explore API integration, please have a look at our endpoint description here: https://multiball-admin.net/api

How do I get API access?

API access is a subscription that is tied to a user account, not to a system. So if your user has API access, then you can access each system via the API to which you have access right. Also, if the user with whom you create an API key has only limited rights on the systems, then the API key is also only allowing for these limited rights.

How to activate API access?

In Systems, navigate to a Dashboard of any of your systems, under Subscriptions you will find the subsection User Subscriptions. There you can buy API access, simply click on Buy now and fill out the modal.

Once that is activated, the Buy now button will change to Active.

How to generate an API access key?

In any of your systems dashboards, go to Settings and click on New API key

Name the key appropriately, so that you can identify it later and hit Add new API key

In the next window, you will see the newly generated credentials, which you then later can use to authenticate API requests.

As mentioned in the dialogue you should save the secrets somewhere since you will not be able to view them again later.

How to use it?

You will find the documentation of our API at https://multiball-admin.net/api. If you are tech-savvy enough, you might already be used to this kind of documentation.

If you are not, let us walk you through an example.

What you have to know for the following, is, that your screensaver can be configured in different ways. One of which is the so-called self-locking mode. Meaning, that the user cannot exit the screensaver by interacting with the wall.
The only way to exit the screensaver is either using the admin interface or, in this case, the API access.

Example Usage

Let's assume the following scenario:

  • You want to use a scheduling/booking service
  • You want to activate the system (start the menu) at a given time, once a booking starts, so that the customer can freely play

Therefore, your task, as the system administrator, would be to configure your bookings software so that it tells our system what to do - via the API. Let's further keep it simple and say that you only want to switch from the screensaver to the menu (let's neglect the switch back after the booking ends).

So, you will have to make the booking software

  • authenticate at our API with the right credentials (the ones generated above)
  • call the right function (switching to the menu, see below)
  • call it for the right court (the one that was booked, see below)
  • and at the right time (when the booking starts)

How to do that depends on the booking software, if you are using e.g. Eversports you will find the relevant article here: https://helpcenter.eversportsmanager.com/what-is-the-provider-api

In the following, we will briefly describe the API endpoints that are relevant to the above scenario.

Switch to another game

https://multiball-admin.net/api#operation/switchGame

To switch to a specific game on a specific court you need the gameId as well as the courtId.

  1. How to find out the courtId?
    You can either call another API endpoint that lists all courts you have access to or, to simplify it in this example, you can also copy your courtId from the URL on your systems dashboard page.



  2. How to find out the gameId of the menu?
    To get a list of all installed and accessible games on your system there is again, another API call described here. You can e.g. use a program like Postman to call that endpoint from your PC and test it.



    As you can see, the gameId of the menu is 627e30abe39a804f4a0e9405

The call that you have to configure in Eversports therefore, would be

  • Method: PUT
  • URL: https://courtadmin.net/api/v1.0/courts/<COURTID>/switchGame
  • Body:
    • gameId: 627e30abe39a804f4a0e9405

In Postman this looks like the following, which as you can see in the reply, worked just expected (Game switch accepted)