Modul 03 · Für IT-Profis

go API — blue office Daten für jedes andere System.

go API stellt Daten und Funktionen aus blue office als vollständige REST-Schnittstelle bereit, intern und extern — frei definierbar wie blue office go selbst.

Infos anfordern
Endpoints — Beispiel einer Konfiguration
GET   /api/v1/artikel?lager=1
GET   /api/v1/artikel/{nr}/bestand
POST  /api/v1/auftrag
GET   /api/v1/auftrag/{nr}/liefertermin
POST  /api/v1/rapport
GET   /api/v1/adresse?suche=meier
Welche Endpoints es gibt und welche Felder sie liefern, definieren Sie — nicht wir.

Wofür Kunden sie einsetzen

Überall dort, wo blue office Daten mit anderen Systemen zusammenspielen sollen.

Externe Plattformen

Artikel, Preise und Verfügbarkeiten aus blue office an eine angebundene Plattform übergeben, eingehende Bestellungen als Auftrag zurückschreiben. Kein nächtlicher Abgleich, kein zweiter Datenbestand.

Partner- und Lieferantensysteme

Bestellungen übermitteln, Auftragsbestätigungen und Trackingdaten übernehmen, Preislisten synchron halten.

Eigene Entwicklungen

Ihre IT baut das Werkzeug, das genau zu Ihrem Prozess passt — und greift dafür auf die ERP-Daten zu, ohne direkt in die Datenbank zu schreiben.

Automatisierte Prozesse

Ganze Abläufe laufen ohne Klick: Bestände melden, Belege erzeugen, Dokumente ablegen, Systeme informieren.

Frei definierbar heisst: Sie bestimmen den Vertrag

Sie legen fest, welche Daten die API bereitstellt, welche Felder sichtbar sind, welche Funktionen aufrufbar sind und wer sie aufrufen darf. Alles, was die Oberfläche von blue office go kann, kann auch eine Integration.

Zugriff über Token pro Anwendung, Rechte pro Endpoint, Protokollierung jeder Anfrage.

REST & JSON

Standardformate, mit jedem Werkzeug ansprechbar.

Token pro Anwendung

Getrennte Zugänge für Shop, Partner und Interne.

Rechte pro Endpoint

Lesend, schreibend oder gar nicht — feldgenau.

On-premises oder Cloud

Dort betrieben, wo Ihre Daten liegen dürfen.

FAQ

Häufige Fragen zur go API

Ist die API bei meiner Installation verfügbar?

Die API ist Bestandteil von blue office go und wird als Lizenzoption freigeschaltet. Sie läuft auf derselben Datenbank wie Ihre bestehende Installation, ausser der Freischaltung sind keine weiteren technischen Voraussetzungen nötig.

Wie sieht die Schnittstelle konkret aus?

REST über HTTPS mit JSON. Es gibt einen festen, versionierten Satz von Operationen: Abfragen, Anlegen, Ändern, Löschen und das Ausführen von Geschäftsfunktionen. Welche Daten dahinterstehen, bestimmt die Liste, die Sie in der Anfrage adressieren: Konfiguration statt Programmierung, auch für Integrationen. Aufrufbar aus jeder Programmiersprache und aus Werkzeugen wie Make, Power Automate oder n8n.

Auf welche Daten kann die API zugreifen?

Auf alle Daten von blue office: Adressen und Ansprechpartner, Artikel, Preise und Bestände, Belege (Offerte, Auftrag, Lieferschein, Rechnung) inklusive Positionen, Projekt- und Auftragsdaten sowie Dokumente. Welche Spalten eine Liste liefert und welche Zeilen sie zeigt, definieren Sie pro Liste, die anfragende Anwendung sieht genau diese Felder und keine anderen.

Kann ich gezielt filtern und sortieren, oder bekomme ich immer die ganze Liste?

Sie filtern pro Spalte, auch auf Wertebereiche und mit Platzhaltern, sortieren nach beliebiger Spalte und blättern seitenweise durch das Ergebnis. Ohne Angabe liefert eine Abfrage 20 Zeilen.

Muss ich dafür meine Datenbank nach aussen freigeben?

Nein. Die Datenbank bleibt vollständig intern, es wird kein SQL-Port nach aussen geöffnet. Der Zugriff läuft ausschliesslich über den blue office go Dienst per HTTPS mit authentifiziertem Zugang. Gegenüber einem direkten Datenbankzugriff ist das der deutlich sicherere Weg.

Schreibt die API direkt in die ERP-Tabellen?

Nein. Schreibende Zugriffe laufen über dieselben Geschäftsfunktionen wie der blue office Client, Nummernkreise, Preisfindung, Lagerbewegungen und Belegregeln greifen unverändert. Über die Schnittstelle entsteht kein Datensatz, der anders zustande kommt als über die Oberfläche.

Kann ich einen technischen Benutzer mit reinem Lesezugriff anlegen?

Ja. Es wird ein eigener blue office Benutzer angelegt, ausdrücklich als API-Benutzer markiert und einer Berechtigungsgruppe zugeordnet. Die Freigabe erfolgt pro Liste, nicht pauschal: Sie erlauben pro Liste einzeln, ob gelesen, eingefügt, geändert, gelöscht und ob Dokumente hochgeladen werden dürfen. Ohne diese Häkchen bleibt der Zugang lesend. Zusätzlich lässt sich pro Gruppe ein permanenter Zeilenfilter hinterlegen, der technische Benutzer sieht dann etwa nur Belege eines bestimmten Bereichs.

Braucht dieser technische Benutzer eine Benutzerlizenz?

Nein. Ein reiner API-Benutzer belegt keinen Arbeitsplatz (Seat), er benötigt die API-Lizenzoption, nicht eine weitere Benutzerlizenz.

Wie funktioniert die Authentifizierung, und was passiert bei einem gestohlenen Token?

Jeder Aufruf trägt Mandant und Zugangstoken. Ein Token wird einmalig im Klartext angezeigt und in der Datenbank nur als Hash abgelegt, es lässt sich nicht wieder auslesen. Pro Benutzer sind mehrere Tokens möglich, jedes mit Beschreibung und optionalem Ablaufdatum, sodass Sie einer einzelnen Anwendung den Zugang entziehen können, ohne alle anderen zu stören. Ein verlorenes Token löschen Sie in der Benutzerverwaltung; es ist im selben Moment ungültig.

Gibt es Limits?

Ja, ein Aufruflimit pro Token, standardmässig 60 Anfragen pro Minute, für Integrationen mit höherem Volumen erhöhbar. Wird es überschritten, antwortet die Schnittstelle mit einem regulären „zu viele Anfragen" samt Wartezeit, statt den Server zu belasten.

Was wird protokolliert?

Jeder schreibende Zugriff wird in der Datenbank protokolliert: Benutzer, Zeitpunkt, betroffene Liste bzw. Funktion, die übergebenen Werte, das Ergebnis und ob der Aufruf fehlgeschlagen ist. Lesende Zugriffe werden im Server-Log mit Benutzer, Mandant und Herkunfts-IP festgehalten. Fehlgeschlagene Anmeldeversuche mit ungültigem Token sind ebenfalls sichtbar.

Welche Dokumentation gibt es?

Eine interaktive OpenAPI-Dokumentation mit allen Operationen, Parametern und Beispielaufrufen, direkt im Browser ausprobierbar. Für eine Evaluation stellen wir sie auch vor dem Kauf zur Verfügung.

Was passiert bei einem blue office Update?

Ihre Integration bleibt bestehen. Weil die Schnittstelle auf konfigurierten Listen aufsetzt und nicht auf Custom-Code, überstehen Anbindungen Updates ohne Nacharbeit.

Welches System soll mit blue office reden?

Schicken Sie uns Ihr Szenario. Sie erhalten eine Einschätzung, wie die Endpoints dafür aussehen.

Infos anfordern