API Documentation

Partybroker’s API can be used to integrate third-party software such as POS-systems or other applications to Partybroker. This documentation explains how to use the Partybroker API.

Architecture

A POS integration is responsible for ensuring that drinks sold from the POS system are automatically transferred to party brokers and that current drink prices are automatically transferred to the POS system. Therefore, the following three solution approaches are possible.

Preconditions

To use the complete functionality of the Partybroker-API, you need Partybroker Premium. Without active Partybroker-Premium-mode you can access only the first three drinks of your party.

API-Credentials

Every API-call must be authenticated with Basic-Auth. You can generate the required API credentials in your Partybroker-account in the section “API-Credentials”.

Your credentials can be used for all parties of your account. Once created, API-credentials are valid until you manually disable them or create new ones.

Partybroker Party und Drinks

Of course you need a completely configured Partybroker Party as well as configured Drinks. In case your POS-System is not able to handle the Partybroker-internal drinkIds, you can enter the Ids of your external System to the datafield “externalId” of your Drinks in Partybroker

Please find the IDs of your parties and drinks next to their title on the corresponding pages in your Partybroker account.

During use

A party is active as long as at least one Barscreen or Clientscreen is signed in or as long as at least one API-client sends API-requests. If an API-client does not send requests for more then 3 price-calculation-intervals (default: 1 minute * 3 = 3 minutes), it will be automatically signed off.

Postman Collection

You can use our Postman Collection to test the API. Just use the included environment template and set your API credentials.

API-methods

Host

The Partybroker-API is accessible via the following URL:

https://app.partybroker.net:3700/api/[PartyID]

You can find your PartyId next to the title of your Party in your Partybroker Account.

Authentification

Every API-Call must be authenticated with Basic-Auth.

Get Drinks

Returns a list of all drinks of your party.

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

Buys one or more drinks. Instead of “id” one can also provide “externalId”. In one request both 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