Was ist ein API-Benutzer
Ein API-Benutzer ist ein eigener System-Benutzer, über den externe Systeme auf die Crownbeam-API zugreifen. Für den API-Zugriff brauchst du zwingend einen solchen API-Benutzer, ein persönlicher Account genügt dafür nicht. Du legst diesen Benutzer selbst an und gibst ihm gezielt die Berechtigungen, die das angebundene System wirklich braucht.
Du findest den Bereich unter Einstellungen → Meine Daten → API Verwaltung.
Hinweis: Die API Verwaltung ist als Beta gekennzeichnet. Einige Unterseiten und Buttons werden noch auf Englisch angezeigt. In dieser Anleitung stehen die englischen Bezeichnungen jeweils in Klammern.
So legst du einen API-Benutzer an
Öffne die Einstellungen über das Zahnrad-Symbol oben rechts.
Wähle unter Meine Daten den Menüpunkt API Verwaltung.
Klicke im Bereich API-Benutzer (API Users) auf API Benutzer verwalten.
Klicke oben rechts auf Systembenutzer erstellen (Create Systemuser).
Trage einen Namen (Name) ein und halte in der Beschreibung (Description) fest, wofür der Benutzer verwendet wird.
Wähle unter Sprache (Language) die gewünschte Sprache aus.
Klicke auf Erstellen.
Tipp: Lege pro angebundenem System einen eigenen API-Benutzer an und benenne ihn danach. So siehst du in der Liste sofort, welcher Zugang wozu gehört, und kannst einzelne Anbindungen getrennt voneinander abschalten.
Welche Berechtigungen es gibt
Die verfügbaren Berechtigungen siehst du in der API Verwaltung über den Button Verfügbare Berechtigungen. Crownbeam ermittelt diese Liste automatisch aus den vorhandenen API-Endpunkten.
Die Berechtigungen sind nach Datenbereich gruppiert, zum Beispiel Aufträge (Order), Dateien (Files), Nachrichten (Message) und Standorte (Location). Pro Bereich gibt es vier Aktionen:
Aktion | Was sie erlaubt |
Hinzufügen (ADD) | Neue Einträge anlegen |
Ändern (CHANGE) | Bestehende Einträge bearbeiten |
Löschen (DELETE) | Einträge löschen |
Ansehen (VIEW) | Einträge lesen |
Zu jeder Berechtigung stehen der Name, der technische Codename wie view_order und eine ID. Diese Angaben braucht in der Regel nur der Entwickler, der die Anbindung umsetzt.
Wichtig: Gib einem API-Benutzer nur die Berechtigungen, die das angebundene System wirklich benötigt. Ein Benutzer, der Daten nur ausliest, braucht kein Löschen.
Die Rechte deines Teams sind davon getrennt. Sie werden weiterhin unter Einstellungen → Mein Unternehmen → Team vergeben, wie in Benutzerrechte verwalten beschrieben.
Welche APIs zur Verfügung stehen
Crownbeam stellt drei REST-APIs zur Verfügung. Welche davon du brauchst, hängt davon ab, aus welcher Perspektive das externe System arbeitet:
API | Wofür |
Admin API | (Aktuell ohne Funktionen !) |
Lab API | Zugriff aus Sicht des Labors |
Practice API | Zugriff aus Sicht der Praxis |
Die Übersicht öffnest du in der API Verwaltung über API-Portal öffnen (Visit API Portal). Zu jeder API findest du dort die Dokumentation, das Schema und eine Swagger-Oberfläche zum Testen sowie die unterstützten Authentifizierungsmethoden.
Hinweis: Brauchst du Unterstützung bei der Umsetzung einer Integration, wende dich an [email protected].
FAQs
Kann ich einen API-Benutzer selbst anlegen?
Du kannst einen API-Benutzer selbst anlegen. Der Weg dafür ist Einstellungen → Meine Daten → API Verwaltung → API Benutzer verwalten und dort Systembenutzer erstellen (Create Systemuser). Du musst dafür keine Anfrage an den Support stellen.
Warum brauche ich für die API einen eigenen Benutzer?
Für die API ist ein eigener Benutzer verpflichtend, damit der technische Zugriff getrennt von persönlichen Accounts läuft. So kannst du die Berechtigungen gezielt auf das angebundene System zuschneiden und den Zugang abschalten, ohne einen Mitarbeiter-Account zu verändern
Wo finde ich die API-Dokumentation?
Die API-Dokumentation liegt im API-Portal. Du erreichst es über Einstellungen → Meine Daten → API Verwaltung und den Button API-Portal öffnen (Visit API Portal).