Zum Beta-Testen eingeladen: Das Modul REST-API ist kostenlos im Feature Store. Du kannst beeUnity-Daten (z. B. Lager, Bestände, Versand) an eigene Tools, Auswertungen oder Automatisierungen anbinden. Wir freuen uns über dein Feedback aus dem Beta-Test.
Voraussetzungen
- Zugang zum Feature Store und Berechtigung, Module zu installieren.
- Für den Beta-Stand: ggf. passende App-Umgebung – Details zum Kanalwechsel: Kanal wechseln.
Modul installieren
- Öffne den Feature Store (über Einstellungen bzw. die Modul-Übersicht).
- Suche das Modul REST-API (Kategorie Verbindungen).
- Installiere bzw. aktiviere es – es ist kostenlos.
Keys anlegen
- Öffne Einstellungen › REST-API-Keys.
- Vergib einen Namen und wähle mindestens eine Berechtigung – beides ist Pflicht.
- Lege den Key an (Secret nur einmal sichtbar – sicher speichern).
- Optional: weitere Keys für getrennte Systeme. In der Nutzungsübersicht siehst du Aufrufe und Fehler.
- Lade die Client-Vorlage für gängige API-Testprogramme herunter (mit oder ohne Secret – mit Secret erscheint ein Warnhinweis).
Die Seite API-Playground
Öffne Controlling › Übersicht und dort unter Werkzeuge & Analysen den API-Playground. Die Seite hat vier Reiter:
- Erste Schritte: Authentifizierung, Base URL, Fehlercodes, Rate Limiting und Code-Beispiele.
- Referenz: Alle freigegebenen Endpunkte, gegliedert nach Modul und Ressource, mit Suche und Schemas. Es erscheinen nur Module, die für deine Firma aktiv sind.
- Playground: Endpunkt wählen (Filter nach Modul, Suche nach Pfad), mit Sitzung oder Key testen und die Antwort prüfen. Lagerplätze und Bestände findest du auch über Lagercode. Schreibende Aufrufe (POST, PUT, DELETE) musst du bestätigen; sie ändern echte Daten.
- Downloads: Die Spezifikation als OpenAPI-3-Datei (
openapi.json, Swagger-kompatibel) zum Import in Swagger Editor, Postman, Insomnia, Bruno oder Code-Generatoren.
Gut zu wissen: Mit API-Key und Secret nutzt du die Kern-API (Bestand, Lagerplätze, Anweisungen, Adressprüfung, Sendungen). Modul-Endpunkte laufen mit deiner angemeldeten Sitzung und deinen Rechten. Interne Schnittstellen der App sind bewusst nicht dokumentiert.
Tipp: Beta heißt: Funktionen können sich noch ändern. Melde Auffälligkeiten gern dem Support – so wird die REST-API robuster für alle.