Öffentliche REST-API

AuraPOS bietet eine öffentliche REST-API unter https://mon.aurapos.be/api/v1/*, um externen Integrationen (ERP, E-Commerce, BI, Analytics) Ihre Daten read-only zu konsumieren.

Verfügbarkeit

Zugänglich vom AuraPOS-Web-Backend:

• Inbegriffen in Group und Restaurant Group
• Option 24 €/Monat für Express / Boutique / Studio / Restaurant Einzelstandort

Interaktive Swagger-Dokumentation

Vollständige OpenAPI 3.1-Spec visuell erkundbar: https://mon.aurapos.be/api/docs

Authentifizierung

Alle Anfragen erfordern Header X-API-Key: ak_xxx....

API-Schlüssel generieren

1. Einloggen auf https://mon.aurapos.be
2. Navigieren zu Einstellungen → API (nur Owner)
3. Klick + Neuer Schlüssel
4. Name geben + Scopes auswählen:
   • read:catalogue — Produkte + Familien
   • read:clients — globale Kunden + Treue
   • read:tickets — Tickets + Zeilen
   • read:promotions — Promotionen
5. Schlüssel generieren und sofort kopieren (nicht mehr sichtbar)

Sichere Speicherung serverseitig

Nur SHA-256-Hash in DB gespeichert.

Rate-Limiting

60 Anfragen/Minute pro Schlüssel. Headers X-RateLimit-Limit / Remaining / Reset + Retry-After bei 429.

Versionsverwaltung

Alle Routen unter /api/v1/. Künftige v2 wird coexistieren.

Verfügbare Endpunkte (v1)

GET /api/v1/produits

Scope: read:catalogue. Query: ?actif=true|false, ?limit=N (max 200), ?offset=M.

GET /api/v1/familles

Scope: read:catalogue.

GET /api/v1/clients

Scope: read:clients. ⚠️ DSGVO-Filter: email und telephone werden maskiert wenn keine Marketing-Einwilligung.

GET /api/v1/tickets

Scope: read:tickets. Query: ?debut=YYYY-MM-DD, ?fin=YYYY-MM-DD, ?facturesOnly=true, ?withLignes=true.

GET /api/v1/promotions

Scope: read:promotions.

curl-Beispiele

curl -H "X-API-Key: ak_xxx..." \
  "https://mon.aurapos.be/api/v1/produits?actif=true&limit=10"

Sicherheits-Best-Practices

• Ein Schlüssel pro Integration
• Minimum-Scope
• Vault-Speicherung (1Password, AWS Secrets Manager)
• Periodische Rotation
• last_used_at überwachen

Typische Anwendungsfälle

ETL → Data Warehouse, E-Commerce-Sync, Custom BI-Dashboard, Email-CRM, Automatisierte Buchhaltung.

Webhooks

Für Echtzeit-Benachrichtigungen siehe Webhooks.

Für die vollständige französische Dokumentation siehe /fr/docs/api-publique.