Developer
Test Mode Sign In Get started
BEEP! Developer Platform

Build the future of
retail, with BEEP!

Integriere Scan & Go, digitale Angebote und Click & Collect direkt in dein System. Vollständige API, Sandbox-Umgebung und Live-Webhooks. In Minuten startbereit. Integrate Scan & Go, digital offers and Click & Collect directly into your system. Complete API, sandbox environment and live webhooks. Ready in minutes.

Quickstart Guide Open Sandbox API Reference →
bash: First API call
# 1. Fetch your sandbox stores curl -X GET \ "https://europe-west6-beep-c6786.cloudfunctions.net/apiGateway/api/v1/fetchStores" \ -H "Authorization: Bearer bk_test_sk_YOUR_KEY" \ -H "X-Beep-Store-Id: sandbox_store_001" # 2. Check in a customer (start Scan & Go session) curl -X POST \ "https://europe-west6-beep-c6786.cloudfunctions.net/apiGateway/api/v1/checkIn" \ -H "Authorization: Bearer bk_test_sk_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"storeId":"sandbox_store_001","userId":"usr_test_42"}' # Response → { "success": true, "sessionId": "sess_k7aB3xQm9wPz", "checkedInAt": "2026-02-27T09:41:00.000Z" }

Was du bauen kannstWhat you can build

Scan & Go
Kassenloses Einkaufen. Check-in via QR → Produkte scannen → Checkout. Vollständige Session-API mit Echtzeit-Status.Cashier-free shopping. Check-in via QR → Scan products → Checkout. Full session API with real-time status.
Digitale AngeboteDigital Offers
Angebote programmatisch erstellen, veröffentlichen und verwalten. Scope-basiert von lokal bis national. Echtzeit-Analytics inklusive.Create, publish and manage offers programmatically. Scope-based from local to national. Real-time analytics included.
Produkt & Katalog
Produktdaten über API oder bidirektionalen POS-Sync einpflegen. EAN-basiert, mit Bildern, Kategorien und MwSt-Sätzen.Import product data via API or bidirectional POS sync. EAN-based, with images, categories and VAT rates.
Click & Collect
Online-Bestellungen mit Filialabholung. Bestellannahme, Status-Updates und Pickup-Zeit-Verwaltung per API.Online orders with in-store pickup. Order acceptance, status updates and pickup time management via API.
Webhooks
Echtzeit-Events für Checkout, Angebote, Store-Check-ins und DMs. HMAC-signiert, mit Retry-Logik.Real-time events for checkout, offers, store check-ins and DMs. HMAC-signed, with retry logic.
Datenformate & ImportData Formats & Import
POS-Systeme, Excel/CSV-Import, ERP-Anbindung. Alle akzeptierten Formate mit Beispielen.POS systems, Excel/CSV import, ERP integration. All accepted formats with examples.
POS / ERP / PSP
Bidirektionale Sync-API für jedes Kassensystem. ERP-Anbindung, PSP-Konfiguration und Payment Processing. Kein Vendor-Lock-in.Bidirectional sync API for any POS system. ERP integration, PSP configuration and payment processing. No vendor lock-in.
Analytics & ExportAnalytics & Export
Umsatz-KPIs, Kohorten-Analyse, LTV-Segmente und Heatmaps. CSV/JSON-Export für BI-Tools.Revenue KPIs, cohort analysis, LTV segments and heatmaps. CSV/JSON export for BI tools.

PAKETEPACKAGES

Welche APIs sind für dich zugänglich?Which APIs are available to you?

Jedes Paket schaltet weitere API-Ressourcen und Endpunkte frei.Each package unlocks additional API resources and endpoints.

DISCOVER
KostenlosFree
Basis-IntegrationBasic Integration
Kostenlos starten →Get started free →
ASSIST
Chat
In-Store-Chat per QRIn-Store Chat via QR
Assist anfragen →Request Assist →
GO
Angebote
Angebote, Click & Collect, LoyaltyOffers, Click & Collect, Loyalty
GO anfragen →Request GO →
GROW
Scan & Go
Scan & Go + Alle ModuleScan & Go + All Modules
GROW anfragen →Request GROW →
PRIME
IndividuellCustom
Alle Module + Analytics + Premium SupportAll Modules + Analytics + Premium Support
Dedizierter IntegrationsserviceDedicated Integration Service Persönlicher Ansprechpartner, SLA-Garantie, Onboarding-Support und individuelle Vertragsgestaltung. Personal contact, SLA guarantee, onboarding support and custom contract terms.
Prime anfragen →Request Prime →
Chat, Team-Chat und FAQs nutzen das Firebase SDK, nicht bk_*-API-Keys.Chat, Team Chat and FAQs use the Firebase SDK, not bk_* API keys.
Diese DISCOVER-Features basieren auf Firestore-Echtzeit-Listenern direkt im Client. Kein REST-Endpunkt erforderlich. Das Firebase JS/Flutter SDK mit dem BEEP!-Projekt initialisieren und den Quickstart Guide → befolgen. These DISCOVER features rely on Firestore real-time listeners directly in the client. No REST endpoint required. Initialize the Firebase JS/Flutter SDK with the BEEP! project and follow the Quickstart Guide →.

DEVELOPER RESSOURCENDEVELOPER RESOURCES

SDKs, Specs & ToolsSDKs, Specs & Tools

Offizielle Client-Libraries, OpenAPI-Spec und Echtzeit-Status. Official client libraries, OpenAPI spec and real-time status.

Node.js SDK
TypeScript · Zero Dependencies
Install
npm install @beep_technologies/node
Quelle: sdks/node/ Source: sdks/node/
Python SDK
snake_case · Zero Dependencies
Install
pip install beep-sdk
Quelle: sdks/python/ Source: sdks/python/
Dart / Flutter SDK
Typed · http Package
Install
dart pub add beep_sdk
Quelle: sdks/dart/ Source: sdks/dart/
OpenAPI 3.0
YAML SpecYAML Spec →
Postman Collection
Import in PostmanImport in Postman →
API Status
Alle Systeme OKAll Systems Operational

IN 3 SCHRITTEN STARTENGET STARTED IN 3 STEPS

Dein erster Sandbox-Call in unter 5 MinutenYour first Sandbox call in under 5 minutes

1
Developer Account anlegenCreate a Developer Account
Registriere dich mit deiner E-Mail oder deinem Google-Account. Dein Test-API-Key wird sofort generiert, kein Warten, kein Support-Ticket.Sign up with your email or Google account. Your test API key is generated instantly, no waiting, no support ticket.
Account erstellen →Create account →
2
API-Key kopieren & ersten Call machenCopy API key & make your first call
Du erhältst sofort bk_test_pk_… und bk_test_sk_…. Die Sandbox hat 2 vorbereitete Test-Stores mit realistischen Produktdaten.You instantly receive bk_test_pk_… and bk_test_sk_…. The sandbox includes 2 pre-configured test stores with realistic product data.
Quickstart Guide →
3
Live schaltenGo live
Wenn du an einem BEEP-Händlervertrag interessiert bist, verknüpfe dein Developer-Konto mit deinem echten Store. Live-Keys ersetzen die Test-Keys ohne Code-Änderung.If you are interested in a BEEP merchant contract, link your developer account to your real store. Live keys replace test keys without any code changes.
Vertrieb kontaktieren →Contact Sales →