Maschinenintegrationen mit einem Workspace SDK anbinden

Nutzen Sie die offiziellen Go-, Node.js- oder PHP-SDKs für serverseitige Integrationen mit einem festen Mandanten. Nach diesem Quickstart erkennt Ihr Dienst die freigegebenen Ressourcen und greift mit einem eingeschränkten API-Key darauf zu.

SDK auswählen

Verwenden Sie das SDK in einem Backend oder Worker. Binden Sie den Node.js-Client und seinen API-Key nicht in Browsercode ein. Native Android-Apps verwenden stattdessen das Android-SDK.

Voraussetzungen

• eine über HTTPS erreichbare Workspace-Installation,
• ein tenantgebundener API-Key mit den minimal benötigten Berechtigungen,
• dieselbe Versionsnummer für Workspace und SDK.

Die SDKs werden nacheinander aktiviert. Prüfen Sie vor der Installation im jeweiligen Paketregister, ob die Version veröffentlicht ist. Nutzen Sie bis dahin den dokumentierten HTTP-Vertrag oder nucli.

Paket installieren

Wählen Sie genau einen Befehl und ersetzen Sie 7.19.0 durch Ihre Workspace-Version:

go get git.schukai.me/releases/nucleus-sdk-go/v7@v7.19.0
npm install @schukai/nucleus-sdk@7.19.0
composer require schukai/nucleus-sdk:7.19.0

Bei einer neuen Workspace-Hauptversion ändert sich der Go-Modulpfad, zum Beispiel von /v7 auf /v8.

Client verbinden

Übergeben Sie Basis-URL, Key-ID und Key-Secret über die sichere Laufzeitkonfiguration Ihrer Anwendung. Der Client ruft zuerst die öffentliche Discovery und anschließend die authentifizierten Ressourcen-Entrypoints ab. Verwenden Sie nur die zurückgegebenen same-origin URLs; bauen Sie Ressourcenpfade nicht selbst zusammen.

Die SDKs unterstützen Discovery, Ressourcen-Entrypoints, Ressourcen-Metadaten, Listen und serverseitig angebotene Aktionen. Fachpayloads bleiben JSON. Interaktive Anmeldung, 2FA und Sitzungsverwaltung gehören nicht zum Maschinenprofil.

Jedes Paket enthält ein ausführbares examples/quickstart-Programm. Es prüft API v1, wählt einen vom Server angekündigten lesbaren Entrypoint und lädt höchstens einen Datensatz. Die jeweilige README nennt die benötigten Umgebungsvariablen und den sprachspezifischen Startbefehl.

Ergebnis prüfen

Die Einrichtung ist erfolgreich, wenn:

1. Discovery den API-Major v1 meldet,
2. die Ressourcenabfrage nur die für Key und Mandant erlaubten Entrypoints liefert,
3. Fehler über HTTP-Status und den stabilen errorCode verarbeitet werden.

Protokollieren Sie niemals API-Keys, Authorization-Header, vollständige Payloads oder komplette Fehlerantworten. Ordnen Sie errorCode in Ihrer Anwendung einer eigenen lokalisierten Meldung zu; die SDKs liefern derzeit nur englische technische Texte.

Nächster Schritt

Öffnen Sie nach der Installation die englische README des Pakets. Sie enthält sprachspezifische Beispiele für Authentisierung, Ressourcen, Fehlerbehandlung und Kompatibilität.