Partybroker's API can be used to connect third-party software such as POS systems or other applications to Partybroker. This documentation explains how you can use this function for your party.
Architecture
A POS integration is responsible for automatically transferring sold drinks from the POS system to Partybroker and automatically transferring current drink prices to the POS system. The following three solutions are therefore available.
Prerequisites
To be able to use the Partybroker API in full, you need Partybroker Premium. Without active Partybroker Premium mode, you can only access the first three drinks of your party.
Generate API credentials
Every API call must be authenticated using Basic-Auth. You can generate the necessary credentials for this in your Partybroker account under "API credentials".
Your credentials are valid for all parties in your account. Created API credentials are valid until you create new ones or remove the current ones.
Partybroker Create party and drinks
Of course, you also need a fully configured Partybroker party and appropriately configured drinks. If the external system cannot handle the Partybroker drink IDs, you can enter the ID of your POS system in the corresponding "externalId" field.
The IDs of your parties and drinks, which you need for the API calls, can be found next to their names in your Partybroker account.
During use
A party remains active as long as at least one bar screen or client screen is logged in or at least one API client regularly sends requests. If an API client does not send any requests for at least 3 price calculation intervals (default: 1 minute * 3 = 3 minutes), it is automatically logged out of the party.
Postman Collection
To test the API, you can use the corresponding Postman Collection. Use our environment template and simply enter your API credentials.
API methods
Host
The Partybroker API can be accessed via the following URL:
https://app.partybroker.net:3700/api/[PartyId]
You can see the PartyId on the overview page of your party next to its title.
Authentication
Each API call must be authenticated with Basic-Auth created above in the request header.
Get Drinks
Outputs a list of all configured drinks.
Request:
GET https://app.partybroker.net:3700/api/[PartyId]/drinks
Response:
[{
"id": 145,
"externalId": "123456",
"title": "Weißbier",
"price": 290,
"currency": "EUR"
},{
"id": 146,
"externalId": "234567",
"title": "Helles",
"price": 230,
"currency": "EUR"
},{
"id": 147,
"externalId": "345678",
"title": "Pils",
"price": 210,
"currency": "EUR"
}]
Buy Drinks
Reports sales for one or more drinks. Instead of "id", "externalId" can also be used. In a request, id and externalId can be used together.
Request:
POST https://app.partybroker.net:3700/api/[PartyId]/drinks
BODY:
[{
"id": 145,
"quantity": 2
},{
"externalId": "POS_222",
"quantity": 2
}]
Response:
[{
"id": 145,
"externalId": "POS_111",
"title": "Weißbier",
"price": 290,
"currency": "EUR"
},{
"id": 146,
"externalId": "POS_222",
"title": "Pils",
"price": 310,
"currency": "EUR"
}]
Models
Drink:
- id: Integer
- externalId: Integer - optional
- title: String
- price String
- currency: String
Buy Drink:
Either id or externalId must be given.
- id: Integer - optional
- externalId: String - optional
- quantity: Integer