Partybroker’s API kann dazu genutzt werden, Drittanbieter-Software wie z.B. Kassensysteme oder andere Applikationen an Partybroker anzubinden. Diese Dokumentation erklärt, wie du diese Funktion für deine Party nutzen kannst.
Architektur
Eine Kassen-Integration ist dafür verantwortlich, dass verkaufte Drinks aus dem Kassensystem automatisch an Partybroker übertragen werden und aktuelle Getränkepreise wiederum automatisch an das Kassensystem übertragen werden. Daher bieten sich die folgenden drei Lösungsansätze an.
Vorraussetzungen
Um die Partybroker-API komplett nutzen zu können, benötigst du Partybroker Premium. Ohne aktiven Partybroker-Premium-Modus kannst du jeweils nur auf die ersten drei Drinks deiner Party zugreifen.
API-Credentials generieren
Jeder API-Call muss per Basic-Auth authentifiziert werden. Die dafür notwendigen Credentials kannst du in deinem Partybroker-Account unter „API-Credentials“ generieren.
Deine Credentials sind für alle Partys deines Accounts gültig. Erstellte API-Credentials sind so lange gültig, bis du neue erstellst oder die derzeitigen entfernst.
Partybroker Party und Drinks erstellen
Natürlich benötigst du auch eine vollständig konfigurierte Partybroker Party sowie entsprechend konfigurierte Drinks. Falls das externe System nicht mit den Partybroker-Drink-Ids umgehen kann, kannst du die ID deines Kassensystems in das entsprechende Feld „externalId“ eintragen.
Die IDs deiner Parties und Drinks, welche du für die API-Calls benötigst, kannst du jeweils neben deren Bezeichnungen unter deinem Partybroker-Account auslesen.
Während der Nutzung
Eine Party bleibt solange aktiv, wie mindestens ein Barscreen bzw. ein Clientscreen angemeldet ist oder mindestens ein API-Client regelmäßig Requests sendet. Sendet ein API-Client für mindestens 3 Preisberechnungsintervalle (Default: 1 Minute * 3 = 3 Minuten) keine Requests, so wird er automatisch von der Party abgemeldet.
Postman Collection
Um die API zu testen, kannst du die entsprechende Postman Collection verwenden. Nutze unser Environment Template und trage einfach deine API-Credentials ein.
API-Methoden
Host
Die Partybroker-API ist über folgende URL erreichbar:
https://app.partybroker.net:3700/api/[PartyId]
Die PartyId kannst du auf der Übersicht-Seite deiner Party neben deren Titel einsehen.
Authentifizierung
Jeder API-Call muss mit oben erstellten Basic-Auth im Request Header authentifiziert werden.
Get Drinks
Gibt eine Liste aller konfigurierten Drinks aus.
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
Meldet Verkäufe für einen oder mehrere Drink. Anstatt „id“ kann auch „externalId“ verwendet werden. In einem Request können id und externalId gemischt verwendet werden.
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