Get started

Ganz cool api fun beep-pay.lu

To use this API, you need an API key. Please contact us at michel@beep-pay.lu to get your own API key.

Register user via email

Diese Aktion registriert einen Benutzer mit Hilfe der Email : 

                        
Diese Abfrage wird eine wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": true,
    "errors": [],
    "data": {
        "user_id": 16
    }
}
Falls die email bereits existiert, wird diese Abfrage wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": false,
    "errors": ['email_already_in_use'],
    "data": {
        "user_id": null
    }
}

HTTP Request:


POST https://api.beep-pay.lu/requests/create-user-email/

Parameter Pflicht Description
first_name JA Vorname des Benutzers
last_name JA Nachname des Benutzers
email JA email des Benutzers
password JA Password md5 gehasht
gender NEIN Entsprechender String fürs Geschlecht:
m: male (männlich)
f: female (weiblich) o: other (anderes)
age NEIN Geburtstag im Format dd/mm/yyyy (16/03/2020)
newsletter NEIN Entsprechender String für die Wahl (default: yes):
y: yes (ja)
n: no (nein)
house_nbr NEIN Hausnummer (String)
additional NEIN Adresszusatz
street NEIN Straße
zip_code NEIN Postleitzahl (String) (L-4236)
city NEIN Ortschaft
country NEIN Land

Login user via email

Diese Aktion meldet einen Benutzer mit Hilfe der Email an : 

                        
Diese Abfrage wird eine wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": true,
    "errors": [],
    "data": {
        "user_id": 16
    }
}
Falls der Benutzer noch nicht verifiziert ist, wird diese Abfrage wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": false,
    "errors": ['not_verified'],
    "data": {
        "user_id": null
    }
}
Falls der Benutzer nicht exisitiert bzw. Login-Daten falsch sind, wird diese Abfrage wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": false,
    "errors": ['user_not_found'],
    "data": {
        "user_id": null
    }
}

HTTP Request:


POST https://api.beep-pay.lu/requests/login-user-email/

Parameter Pflicht Description
token JA Api-Key-Token
email JA email des Benutzers
password JA Password md5 gehasht

Edit user

Diese Aktion verändert oder fügt Informationen hinzu.

                        
Diese Abfrage wird eine wie folgt strukturierte JSON-Antwort zurückgeben (ROLE kann CUSTOMER, WORKER, ADMIN oder ORGANZIER sein):
{
    "success": true,
    "errors": [],
    "data": {
        "user_id": 16,
        "first_name": "Michel",
        "last_name": "Gindt",
        "gender": "m",
        "age": "16/03/2020",
        "newsletter": "y",
        "house_nbr": "59",
        "additional": "",
        "street": "Rue des Martyrs",
        "zip_code": "L-4236",
        "city": "Esch sur Alzette",
        "country": "Luxembourg",
        "role": "WORKER"
    }
}

HTTP Request:


POST https://api.beep-pay.lu/requests/edit-user/

Parameter Pflicht Description
token JA Api-Key-Token
user_id JA user_id
first_name NEIN Vorname des Benutzers
last_name NEIN Nachname des Benutzers
gender NEIN Entsprechender String fürs Geschlecht:
m: male (männlich)
f: female (weiblich) o: other (anderes)
age NEIN Geburtstag im Format dd/mm/yyyy (16/03/2020)
newsletter NEIN Entsprechender String für die Wahl (default: yes):
y: yes (ja)
n: no (nein)
house_nbr NEIN Hausnummer (String)
additional NEIN Adresszusatz
street NEIN Straße
zip_code NEIN Postleitzahl (String) (L-4236)
city NEIN Ortschaft
country NEIN Land
role NEIN CUSTOMER, WORKER, ORGANIZER or ADMIN

Get User-Information

Diese Aktion gibt Auskunft über Benutzerdetails. Entweder Email oder user_id muss angegebenen werden.

                        
Diese Abfrage wird eine wie folgt strukturierte JSON-Antwort zurückgeben (ROLE kann CUSTOMER, WORKER, ADMIN oder ORGANZIER sein):
{
    "success": true,
    "errors": [],
    "data": {
        "user_id": 16,
        "email": "michel@beep-pay.lu",
        "first_name": "Michel",
        "last_name": "Gindt",
        "gender": "m",
        "age": "16/03/2020",
        "newsletter": "y",
        "house_nbr": "59",
        "additional": "",
        "street": "Rue des Martyrs",
        "zip_code": "L-4236",
        "city": "Esch sur Alzette",
        "country": "Luxembourg",
        "role": "WORKER"
    }
}

HTTP Request:


POST https://api.beep-pay.lu/requests/get-user-info/

Parameter Pflicht Description
token JA Api-Key-Token
user_id JA/NEIN Die ID des Benutzers
email JA/NEIN Die Email des Benutzers

Get worker-events

Diese Aktion gibt Auskunft über welche events der User die Rolle WORKER verfügt.

                        
Diese Abfrage wird eine wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": true,
    "errors": [],
    "data": {
        "events": [
            {
                "event_id": 1,
                "name": "Start-Up-Crew 2k21",
                "start": "2020-12-31 20:00:00",
                "end": "2021-01-01 06:30:00",
                "refund_deadline": "2021-01-14 24:00:00",
                "location": "Luxexpo The Box Kirchberg",
                "gradient_start": "#0057e7",
                "gradient_end": "#40e0d0",
                "type": "WRISTBAND",
                "grafic_path": "api.beep-pay.lu/graphics/startup-01.png",
                "currency_name": "SC",
                "logo_path": "api.beep-pay.lu/logos/startup-01.png",
                "cloakroom_price": "2.00"
            },
            {
                "event_id": 14,
                "name": "Sangria Party",
                "start": "2020-06-27 20:00:00",
                "end": "2020-06-28 03:30:00",
                "refund_deadline": null,
                "location": "Wiki Beach Esch sur Alzette",
                "gradient_start": "#b1cfff",
                "gradient_end": "#ce0350",
                "type": "CARD",
                "grafic_path": "api.beep-pay.lu/graphics/sangria-party-03.png",
                "currency_name": "WC",
                "logo_path": "api.beep-pay.lu/logos/sangria-party-01.png",
                "cloakroom_price": "0.00"
            }
        ]
    }
}

HTTP Request:


POST https://api.beep-pay.lu/requests/get-user-info/

Parameter Pflicht Description
token JA Api-Key-Token
user_id JA/NEIN Die ID des Benutzers
email JA/NEIN Die Email des Benutzers

Get Customer-events

Diese Aktion gibt Auskunft über welche events der User verfügt.

                        
Diese Abfrage wird eine wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": true,
    "errors": [],
    "data": {
        "events": [
            {
                "event_id": 1,
                "name": "Start-Up-Crew 2k21",
                "start": "2020-12-31 20:00:00",
                "end": "2021-01-01 06:30:00",
                "refund_deadline": "2021-01-14 24:00:00",
                "location": "Luxexpo The Box Kirchberg",
                "gradient_start": "#0057e7",
                "gradient_end": "#40e0d0",
                "type": "WRISTBAND",
                "grafic_path": "api.beep-pay.lu/graphics/startup-01.png",
                "currency_name": "SC",
                "logo_path": "api.beep-pay.lu/logos/startup-01.png",
                "cloakroom_price": "2.00"
            }
        ]
    }
}

HTTP Request:


POST https://api.beep-pay.lu/requests/get-user-info/

Parameter Pflicht Description
token JA Api-Key-Token
user_id JA/NEIN Die ID des Benutzers
email JA/NEIN Die Email des Benutzers

Get User chip(s)

Diese Aktion gibt Auskunft über welche Chips der User verfügt.

                        
Diese Abfrage wird eine wie folgt strukturierte JSON-Antwort zurückgeben:
{
    "success": true,
    "errors": [],
    "data": {
        "chips": [
            {
                "chip_id": 1,
                "created_at": "2020-12-31 20:00:00",
                "updated_at": "2020-12-31 20:00:00",
                "deleted_at": null,
            },
            {
                "chip_id": 2,
                "created_at": "2020-11-11 20:00:00",
                "updated_at": "2020-11-11 20:00:00",
                "deleted_at": null,
            }
        ]
    }
}

HTTP Request:


POST https://api.beep-pay.lu/requests/get-user-info/

Parameter Pflicht Description
token JA Api-Key-Token
user_id JA/NEIN Die ID des Benutzers
email JA/NEIN Die Email des Benutzers