La API de Partybroker puede utilizarse para conectar software de terceros, como sistemas POS u otras aplicaciones, con Partybroker. Esta documentación explica cómo utilizar esta función para su fiesta.
Arquitectura
Una integración de TPV es responsable de garantizar que las bebidas vendidas desde el terminal de TPV se transfieren automáticamente a los corredores de fiestas y que los precios actuales de las bebidas se transfieren automáticamente al terminal de TPV. Por lo tanto, los siguientes tres enfoques de solución se ofrecen por sí solos.
Requisitos previos
Para usar la API completa de Partybroker, necesitas Partybroker Premium. Sin el modo Premium de Partybroker activo, sólo podrás acceder a las tres primeras bebidas de tu fiesta.
Generación de credenciales de API
Cada llamada a la API debe autenticarse utilizando la autenticación básica. Puede generar las credenciales necesarias en su cuenta de agente de bolsa en «Credenciales de API».
Sus credenciales son válidas para todas las partes de su cuenta. Las credenciales de API creadas son válidas hasta que cree nuevas o elimine las actuales.
Partybroker Party y crear bebidas
Por supuesto, también necesita un Party Broker Party Party Party totalmente configurado, así como bebidas debidamente configuradas. Si el sistema externo no puede manejar los ID de bebidas de Partybroker, puede introducir el ID de su sistema de TPV en el campo correspondiente «externalId».
Los IDs de tus fiestas y bebidas, que necesitas para las llamadas a la API, se pueden encontrar junto a sus nombres en tu cuenta de agente de fiestas.
Durante el uso
Una parte permanece activa siempre y cuando al menos una pantalla de barra o de cliente esté conectada o que al menos un cliente de API envíe solicitudes regularmente. Si un cliente de API no envía ninguna solicitud durante al menos 3 intervalos de cálculo de precio (por defecto: 1 minuto * 3 = 3 minutos), se desconecta automáticamente del equipo.
Postman Collection
Para probar la API, puede utilizar la opción Postman Collection aplicar. Utilice nuestra plantilla de entorno e introduzca sus credenciales de API.
Métodos API
Host
La API de Partybroker está disponible en la siguiente URL:
https://app.partybroker.net:3700/api/[PartyId]
Puedes ver el PartyId en la página de resumen de tu partido junto a su título.
Autenticación
Cada llamada a la API debe autenticarse con la autenticación básica creada anteriormente en el encabezado de la solicitud.
Get Drinks
Emite una lista de todas las bebidas configuradas.
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
Reporta las ventas de una o más bebidas. En lugar de «id», también se puede utilizar «externalId». En una petición, id y externalId pueden ser utilizados de forma mixta.
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