Loyalty Quickstart

In 5 Minuten ein Treueprogramm erstellen anhand der BEEP! API. Dieses Tutorial zeigt die Schritte von der API-Key-Erstellung bis zur ersten Punkte-Vergabe.

Create a loyalty program in 5 minutes with the BEEP! API. This tutorial walks you from API key creation to the first points award.

Schritt 1: API Key erstellenStep 1: Create API Key

Gehe zum Developer Dashboard und generiere einen Test-API-Key.

Go to the Developer Dashboard and generate a test API key.

bash

# Save your API key export SK="sk_test_your_key_here"

Schritt 2: Stamp-Programm erstellenStep 2: Create Stamps Program

cURL

curl -X POST \ ".../apiGateway/api/v1/createLoyaltyProgram" \ -H "Authorization: Bearer $SK" \ -H "Content-Type: application/json" \ -d '{ "storeId": "your_store_id", "programName": "Stammkunden-Karte", "programType": "stamps", "rules": { "requiredStamps": 10, "stampsPerPurchase": 1, "pointsPerCheckin": 1 }, "rewards": [{ "title": "10% Rabatt", "type": "discount_percent", "requiredPoints": 10 }], "earningMethods": ["qr_checkin", "store_checkin"], "branding": { "color": "#2563EB" }, "isActive": true }'

Schritt 3: Kunden anmeldenStep 3: Enroll Customer

cURL

curl -X POST \ ".../apiGateway/api/v1/enrollInLoyaltyProgram" \ -H "Authorization: Bearer $SK" \ -d '{ "programId": "lp_abc123", "userId": "user_xyz" }'

Schritt 4: Punkte vergebenStep 4: Award Points

cURL

curl -X POST \ ".../apiGateway/api/v1/addLoyaltyPoints" \ -H "Authorization: Bearer $SK" \ -d '{ "programId": "lp_abc123", "userId": "user_xyz", "points": 1, "purchaseAmount": 28.50 }'

Schritt 5: Punkte einlösenStep 5: Redeem Points

cURL

curl -X POST \ ".../apiGateway/api/v1/redeemLoyaltyPoints" \ -H "Authorization: Bearer $SK" \ -d '{ "programId": "lp_abc123", "userId": "user_xyz", "points": 10 }'

Earning Methods konfigurierenConfigure Earning Methods

Definiere wie Kunden Punkte oder Stempel sammeln können. Mehrere Methoden gleichzeitig möglich.

Define how customers can earn points or stamps. Multiple methods can be active simultaneously.

JSON

"earningMethods": [ "qr_checkin", // QR-Code am Kassenbereich (GO+) "store_checkin", // GPS Check-in im Geschäft (GO+) "scan_and_go", // Automatisch beim Checkout (GROW+) "click_collect" // Bei Click & Collect Abholung (GO+) ]

QR-Code Format: beep://loyalty/{storeId}/{programId} , Generiere den QR-Code im BEEP! Merchant Dashboard unter „Treueprogramm → QR-Code“. Kunden scannen ihn mit der BEEP! App. Rate-Limits: QR Check-in: 1× pro Stunde · Store Check-in: 1× pro Tag.QR Code Format: beep://loyalty/{storeId}/{programId} , Generate it in the BEEP! Merchant Dashboard under “Loyalty → QR Code”. Customers scan it with the BEEP! app. Rate Limits: QR Check-in: 1× per hour · Store Check-in: 1× per day.

Das war's! Dein Treueprogramm ist jetzt live. Kunden sehen es automatisch im Store-Profil und können über QR-Code, Check-in, Scan & Go oder Click & Collect Punkte sammeln. Webhooks einrichten für Echtzeit-Events.That's it! Your loyalty program is now live. Customers will see it automatically in the store profile and can earn points via QR code, check-in, Scan & Go, or Click & Collect. Set up webhooks for real-time events.

# 1. Programm erstellen curl -X POST \ ".../api/v1/createLoyaltyProgram" \ -H "Authorization: Bearer $SK" \ -d '{"storeId":"store_123", "programName":"Stammkunden-Karte", "programType":"stamps", "rules":{"requiredStamps":10}}' # 2. Kunden anmelden curl -X POST \ ".../api/v1/enrollInLoyaltyProgram" \ -H "Authorization: Bearer $SK" \ -d '{"programId":"lp_abc123", "userId":"user_xyz"}' # 3. Punkte vergeben curl -X POST \ ".../api/v1/addLoyaltyPoints" \ -H "Authorization: Bearer $SK" \ -d '{"programId":"lp_abc123", "userId":"user_xyz", "points":1}' # 4. Punkte einloesen curl -X POST \ ".../api/v1/redeemLoyaltyPoints" \ -H "Authorization: Bearer $SK" \ -d '{"programId":"lp_abc123", "userId":"user_xyz", "points":10}'

const { BeepClient } = require( '@beep_technologies/node' ); const client = new BeepClient( process.env.BEEP_SK ); // 1. Programm erstellen const prog = await client.loyalty.createProgram({ storeId: 'store_123', programName: 'Stammkunden-Karte', programType: 'stamps', rules: { requiredStamps: 10 }, }); // 2. Kunden anmelden await client.loyalty.enroll( prog.programId, 'user_xyz' ); // 3. Punkte vergeben await client.loyalty.addPoints({ programId: prog.programId, userId: 'user_xyz', points: 1, }); // 4. Punkte einloesen await client.loyalty.redeemPoints({ programId: prog.programId, userId: 'user_xyz', points: 10, });

from beep import BeepClient client = BeepClient("bk_test_sk_...") # 1. Programm erstellen prog = client.loyalty.create_program( store_id="store_123", program_name="Stammkunden-Karte", program_type="stamps", rules={"requiredStamps": 10}, ) # 2. Kunden anmelden client.loyalty.enroll( program_id=prog["programId"], user_id="user_xyz", ) # 3. Punkte vergeben client.loyalty.add_points( program_id=prog["programId"], user_id="user_xyz", points=1, ) # 4. Punkte einloesen client.loyalty.redeem_points( program_id=prog["programId"], user_id="user_xyz", points=10, )

import 'package:beep_sdk/beep_sdk.dart'; final client = BeepClient('bk_test_sk_...'); // 1. Programm erstellen final prog = await client.loyalty.createProgram( storeId: 'store_123', programName: 'Stammkunden-Karte', programType: 'stamps', rules: {'requiredStamps': 10}, ); // 2. Kunden anmelden await client.loyalty.enroll( programId: prog['programId'], userId: 'user_xyz', ); // 3. Punkte vergeben await client.loyalty.addPoints( programId: prog['programId'], userId: 'user_xyz', points: 1, ); // 4. Punkte einloesen await client.loyalty.redeemPoints( programId: prog['programId'], userId: 'user_xyz', points: 10, );