Eigene Integration entwickeln
Nutzen Sie diese Seite, wenn Sie eine eigene Anwendung, Middleware, interne Software oder Agentur-Integration an Workspace anbinden möchten. Starten Sie mit dem fachlichen Schnitt und wechseln Sie danach in die technischen Entwicklerseiten.
Vor dem ersten API-Aufruf klären
| Frage | Entscheidung |
|---|---|
| Welcher Use Case soll gelöst werden? | Nur benötigte Daten und Aktionen anbinden, nicht den gesamten Datenbestand spiegeln. |
| Wer führt welche Daten? | Feldhoheit, Datenrichtung und Konfliktregeln dokumentieren. |
| Welche Identität verbindet Datensätze? | Externe IDs, SKUs, E-Mail-Adressen oder Bestellnummern bewusst wählen und absichern. |
| Welche Rechte braucht die Integration? | Nur notwendige Scopes, Tenants und Rollen freigeben. |
| Wie werden Fehler bearbeitet? | Validierungsfehler, Rate Limits, Dubletten und fehlende Referenzen sichtbar machen. |
Technische Einstiegspunkte
| Aufgabe | Dokument |
|---|---|
| Serverfähigkeiten und Ressourcen entdecken | Discovery und Ressourcen |
| API, CLI und Testaufrufe verwenden | CLI und API |
| Eigene Clients robust gegen Ressourcen-Meta bauen | Backend-Integration für eigene Clients |
| Daten chargenweise importieren | Import-Jobs |
| OpenAPI für Analyse und Contract-Checks nutzen | OpenAPI verwenden |
| Storefront oder Portal bauen | B2B-Onlineshop bauen |
Apps anbinden
Nutzen Sie das Modul App Platform, wenn eine eigene App nicht nur Daten über die reguläre API austauscht, sondern eine appseitige Installation, Runtime-Authentifizierung, Feedback-, Support- oder Diagnosemeldungen und kleine serverlesbare Zustände braucht.
Planen Sie zuerst den fachlichen Schnitt:
- Welche App oder Client-Familie wird angebunden?
- Welche Plattformen gehören zum ersten Umfang?
- Welche Meldungen sendet die App bewusst an Workspace?
- Welche kleinen Zustände darf Workspace serverseitig lesen?
- Welche Daten dürfen nie in Meldungen, Zustände oder Logs gelangen?
Ein Administrator legt die App anschließend im Modul App Platform als Registrierung an. Entwickler verwenden danach den Runtime-Vertrag für Installation-Bootstrap, Runtime-Authentifizierung, Submissions und State. Für reine Datenimporte, Storefronts oder serverseitige Middleware bleibt die reguläre API-Integration der passendere Einstieg.
OpenAPI richtig einsetzen
OpenAPI hilft bei DTO-Strukturen, Contract-Checks, Testclients, Privacy-Prüfung und Codegenerierung. Verwenden Sie OpenAPI nicht als Ersatz für Runtime-Discovery. Wenn Workspace Entry Points, Ressourcen-Meta oder Storefront-Verträge veröffentlicht, nutzen Clients diese Laufzeitwerte.
No-Code und Middleware
Tools wie n8n, Make oder Zapier können für einfache Workflows hilfreich sein, wenn sie API-Aufrufe, Webhooks oder geplante Jobs sauber ausführen. Prüfen Sie vorher:
- ob Zugangsdaten sicher gespeichert werden,
- ob personenbezogene Daten und Secrets nicht in Logs landen,
- ob Wiederholungen idempotent sind,
- wie Fehlerfälle und Teilverarbeitungen sichtbar werden,
- ob die Middleware keine eigene unkontrollierte Datenwahrheit erzeugt.
Nächste Schritte
- Lesen Sie zuerst Integration.
- Prüfen Sie danach die passende technische Detailseite.
- Prüfen Sie das Modul
App Platform, wenn Sie eine eigene App mit Installation, Runtime-Authentifizierung, Submissions oder App-State anbinden. - Nutzen Sie Connector-Katalog, wenn Sie ein konkretes Dritt- oder Bestandssystem einordnen möchten.