Licensed to be used in conjunction with basebox, only.
// integration
Integrationen & API
Gilt für
Produkt: Cloud · Server · Zielgruppe: Entwickler / Integrator
Dieser Bereich richtet sich an alle, die basebox in Software und Fachsysteme einbinden: Entwickler, die die OpenAI-kompatible oder die REST-API nutzen, Teams, die MCP-Server anbinden, und IT, die basebox mit Identitätsanbieter, Mail, SIEM oder Fachanwendungen verbindet.
Er enthält bewusst keinen Infrastrukturbetrieb. Installation, GPUs, Kubernetes und Helm stehen unter Entwickler → Installation & Betrieb.
Was Sie brauchen
Für die API genügen zwei Dinge: ein API-Schlüssel, den ein Administrator Ihrer Organisation unter Administration → API-Schlüssel ausstellt, und die Basis-URL Ihrer Umgebung – in basebox Cloud https://aims.basebox.ai, auf basebox Server die Domain Ihrer Installation. Dazu der X-Realm-Header mit dem Realm Ihrer Organisation – in der Cloud die Subdomain, unter der Ihre Organisation basebox nutzt. Alles Weitere steht im Quickstart.
In diesem Bereich
API
| Seite | Inhalt |
|---|---|
| Quickstart | In wenigen Minuten zur ersten Chat-Completion – mit curl und mit dem OpenAI-SDK |
| Authentifizierung | Bearer-Token und X-Realm, Unterschiede Cloud/Server |
| OpenAI-kompatible API | /v1/chat/completions, /v1/models, Swagger UI, IDE- und OpenClaw-Integration |
| REST API | /rest/v1/chat/completions und die Referenz |
| Streaming | Server-Sent Events, was ein Client verarbeiten muss, Reasoning im Stream |
| Fehlerbehandlung | Statuscodes, Meldungen und empfohlenes Client-Verhalten |
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 |
Enterprise-Integration
| Seite | Inhalt |
|---|---|
| Übersicht | Was für Cloud und Server gleich gilt – und was nicht |
| LDAP / OIDC · SIEM · SMTP · VPN / Netzwerk · Fachsysteme | Identität, Audit-Weiterleitung, Mail, Netzwerkpfade, Anbindung von Fachanwendungen |
Den historischen Einstieg in die technische Dokumentation finden Sie unter Technische Dokumentation (Einstieg).
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; auf einem Server muss die REST-API per AISRV_ENABLE_REST_API aktiviert sein, und Konnektor-Dienste werden vom Platform Operator im Cluster bereitgestellt. Enterprise-Integrationen gelten für beide Produkte, die Netzanbindung erfolgt aber einmal aus dem Kundennetz, einmal aus der basebox-Umgebung heraus – siehe Enterprise-Integration.
Benötigen Sie Hilfe? Support kontaktieren