6.5 REST API – Schnittstellen & Integration

Die REST API von calServer ermöglicht es, verschiedene Funktionen des Systems über externe Anwendungen zu steuern. Dazu gehören die Verwaltung von Inventar, Kalibrierungen, Standards, Kunden, Benutzern und Software-Versionen.

Für detaillierte technische Informationen und Beispiele wird die aktuelle API-Dokumentation über Postman bereitgestellt. Diese kann unter folgendem Link eingesehen werden:

🔗 API-Dokumentation in Postman

1 Überblick über die API-Funktionen

Die REST API dient dazu, Daten aus dem System abzurufen oder Änderungen vorzunehmen. Sie bietet unter anderem folgende Funktionen:

• •Inventarverwaltung – Geräte erfassen, aktualisieren und suchen
• •Kalibrierungsmanagement – Kalibrieraufträge verwalten
• •Standards und Referenzwerte – Standardwerte für Kalibrierungen abrufen
• •Kundenverwaltung – Kundendaten hinterlegen und verwalten
• •Benutzerverwaltung – Nutzerkonten anlegen und verwalten
• •Software-Versionen – Informationen zur aktuellen Version abrufen

Jede dieser Funktionen ist über eine eigene Adresse (sog. Endpunkte) erreichbar, die es ermöglicht, gezielt auf die benötigten Daten zuzugreifen.

2 Authentifizierung & Zugriffskontrolle

Um die API nutzen zu können, ist eine Authentifizierung erforderlich. Dafür müssen Zugangsdaten in den Anfragen übermittelt werden:

• •Benutzername
• •Passwort
• •API-Schlüssel (wird im Benutzerkonto generiert)

Ohne gültige Anmeldedaten kann die API nicht verwendet werden.

3 Nutzung der API – Überblick der Hauptfunktionen

Inventarverwaltung

Über die API können Geräte aus dem Inventar gesucht, abgerufen, aktualisiert oder gelöscht werden.

Beispiel: Abruf aller Inventargegenstände

Eine Anwendung möchte eine Liste aller Geräte im System anzeigen.

• •Anfrage:
• •Antwort:

Kalibrierungsmanagement

Die API erlaubt es, Kalibrierungsaufträge abzurufen, zu erstellen oder zu aktualisieren.

Beispiel: Erstellung eines neuen Kalibrierungsauftrags

Ein Gerät soll in die Warteschlange für eine neue Kalibrierung aufgenommen werden.

• •Anfrage:
• •Antwort:

Standards und Referenzwerte

In der API können Kalibrierstandards und Referenzwerte gespeichert und verwaltet werden.

Beispiel: Abrufen der verfügbaren Standards

Eine Software möchte eine Liste der Kalibrierstandards anzeigen, um zu prüfen, welche für eine Messung genutzt werden können.

• •Anfrage:
• •Antwort:

Kundenverwaltung

Die API erlaubt es, Kundeninformationen zu verwalten und abzurufen.

Beispiel: Einen neuen Kunden hinzufügen

Ein neuer Kunde soll im System gespeichert werden.

• •Anfrage:
• •Antwort:

Benutzerverwaltung

Benutzerkonten und Berechtigungen können über die API gesteuert werden.

Beispiel: Abrufen aller Benutzer

Eine Anwendung benötigt eine Liste aller Benutzerkonten.

• •Anfrage:
• •Antwort:

Software-Versionen

Diese API-Funktion gibt Informationen über die installierte Systemversion zurück.

Beispiel: Abrufen der aktuellen Software-Version

• •Anfrage:
• •Antwort:

4 Fehler & häufige Probleme

🔴 Fehlermeldung: Ungültige Anmeldeinformationen

✔ Lösung: Überprüfen, ob Benutzername, Passwort und API-Schlüssel korrekt sind.

🔴 Fehlermeldung: Zugriff verweigert

✔ Lösung: Der Benutzer hat möglicherweise nicht die notwendigen Rechte.

🔴 Fehlermeldung: Keine Daten gefunden

✔ Lösung: Prüfen, ob die richtige Anfrage gestellt wurde und die gewünschten Daten vorhanden sind.

Für detailliertere Informationen kann jederzeit die Postman-Dokumentation genutzt werden.