Licensed to be used in conjunction with basebox, only.
// integration
Integrationen & API
Gilt für
Produkt: Cloud · Server · Zielgruppe: Entwickler / Integrator
Dieser Reiter richtet sich an alle, die basebox in eigene Software einbinden: Entwickler, die die OpenAI-kompatible API nutzen, und Teams, die MCP-Server oder eigene Konnektoren anbinden.
Installation, GPUs, Kubernetes und Helm stehen im Reiter Betreiben.
Hier beginnen: Quickstart
Der Quickstart führt in wenigen Schritten zur ersten Chat-Completion – mit curl und mit dem OpenAI-SDK. Sie brauchen dafür:
- einen API-Schlüssel, den ein Administrator Ihrer Organisation unter Administration → API-Schlüssel ausstellt,
- die Basis-URL Ihrer Umgebung,
- den Header
X-Realmmit dem Realm Ihrer Organisation.
Welche Werte für Cloud und Server gelten, steht im Quickstart.
Die OpenAI-kompatible API
basebox stellt eine OpenAI-kompatible API bereit. Werkzeuge, Bibliotheken und Anwendungen, die für die OpenAI-API geschrieben sind, funktionieren mit Ihrer basebox-Umgebung, wenn Sie die Basis-URL auf /v1 Ihrer Instanz setzen und den X-Realm-Header mitsenden. Die API ist Teil jeder basebox-Installation und muss nicht eingeschaltet werden.
| Seite | Inhalt |
|---|---|
| OpenAI-kompatible API | Überblick: /v1/chat/completions, /v1/models, Swagger UI |
| Benutzerhandbuch | Referenz mit Beispielen, häufigen Fehlern und Troubleshooting |
| Streaming | Server-Sent Events, was ein Client verarbeiten muss, Reasoning im Stream |
| Fehlerbehandlung | Statuscodes, Meldungen und empfohlenes Client-Verhalten |
| IDE-Integration · OpenClaw-Integration | Editor oder Coding-Agent mit basebox verbinden |
MCP und Konnektoren
| Seite | Inhalt |
|---|---|
| MCP-Übersicht | Was das Model Context Protocol in basebox ist; die mitgelieferten Konnektoren |
| MCP-Client | Wie der Assistent Werkzeuge entdeckt, auswählt, aufruft und Ergebnisse rahmt |
| MCP-Server anbinden | Einen MCP-Server registrieren – in der Oberfläche oder per Helm |
| Autorisierungsablauf | Zugangsdaten je Nutzer, Zugriffskontroll-Gate, Sicherheitseigenschaften |
| Konnektoren entwickeln | Architektur, Authentifizierung, Lese-/Schreibzugriff, Berechtigungen, Beispiele |
Die Anbindung an Identitätsanbieter, Mail, SIEM und Fachsysteme steht unter Enterprise-Integration.
Zwei Grundsätze
Berechtigungen bleiben beim Quellsystem. Wenn der Assistent über einen Konnektor auf ein externes System zugreift, tut er das mit den Zugangsdaten der jeweiligen Person. basebox kopiert oder erweitert keine Rechte.
Werkzeugergebnisse sind Daten, keine Anweisungen. Alles, was aus einem Konnektor oder der Websuche zurückkommt, wird als Daten gerahmt. Bauen Sie Konnektoren so, dass sie strukturierte, begrenzte Ergebnisse liefern.
Cloud oder Server – was ändert sich?
Wenig. Basis-URL und X-Realm unterscheiden sich, und auf einem Server stellt der Platform Operator Konnektor-Dienste im Cluster bereit. Enterprise-Integrationen gelten für beide Produkte; die Netzanbindung erfolgt beim Server aus dem Kundennetz, in der Cloud aus der basebox-Umgebung heraus – siehe Enterprise-Integration.
Nächster Schritt: Quickstart
Benötigen Sie Hilfe? Support kontaktieren