API in CAQ.Net

Mit der CAQ.Net OpenAPI (Application Programming Interface) wird Qualität zum vernetzten Bestandteil Ihrer digitalen Systemlandschaft. Ob MES (Manufacturing Execution System), ERP (Enterprise-Resource-Planning), Smartphone-App oder individuelles Frontend: Funktionen und Daten aus CAQ.Net lassen sich flexibel in bestehende Anwendungen einbinden und in Echtzeit nutzen. Die offene Dokumentation schafft dabei die Freiheit, eigene Lösungen passgenau zu entwickeln.

Wenn Systeme miteinander sprechen – API in der Praxis

An der Maschine

Ein Mitarbeiter möchte die Einrichtung einer Maschine vornehmen und identifiziert sich direkt an der Anlage per Chip.
Das MES fragt über die OpenAPI automatisch in der CAQ-Software ab, ob der Mitarbeiter über die erforderlichen Qualifikationen verfügt.

Qualifikation zur Maschinenbedienung prüfen

• Ja, die benötigte Qualifikation ist vorhanden und die Maschine kann in Betrieb genommen werden.
• Nein, die benötigte Qualifikation ist nicht vorhanden, ein entsprechender Hinweis erscheint und die Maschine kann nicht in Betrieb genommen werden.

Nach dem gleichen Prinzip kann ebenfalls über die OpenAPI direkt abgefragt werden, ob relevante Dokumente zur Kenntnis genommen wurden.

Kenntnisnahme relevanter Dokumente prüfen

• Ja, das Dokument wurde zur Kenntnis genommen und der Mitarbeiter kann mit der Arbeit fortfahren.
• Nein, das Dokument wurde nicht zur Kenntnis genommen und es erscheint ein entsprechender Hinweis. Das erforderliche Dokument kann nun direkt an der Maschine anzeigt und zur Kenntnis genommen werden, ohne die CAQ.Net-Anwendung öffnen zu müssen.

Die Maschine ist an das MES angebunden, aber Qualifikationen werden in der Schulungsmanagement-Software Qualify.Net und zu schulende Dokumente über die Dokumentenmanagement-Software QBD.Net gepflegt. Was passiert ist, ist dass die zwei Systeme sich in Echtzeit ausgetauscht haben. Das MES hat das CAQ-System per OpenAPI gefragt, ob der identifizierte Mitarbeiter die Maschine bedienen darf und das CAQ-Modul hat geprüft, ob er bereits die notwendigen Unterweisungen in der aktuellsten Ausprägung erhalten hat.

Eigene Apps oder Frontends

Über die API können individuelle Apps, Webanwendungen oder mobile Anwendungen entwickelt werden, die gezielt auf Funktionen und Daten von CAQ.Net zugreifen. So lassen sich beispielsweise eigene Benutzeroberflächen für bestimmte Prozesse erstellen.

Instandhaltung und Lager

In diesem Beispiel wurde mittels OpenAPI eine individuelle App entwickelt, die sowohl auf die Daten des ERP-Systems als auch auf die Lagerverwaltung der Instandhaltungsmanagement-Software PMS.Net zugreifen kann. Ein Mitarbeiter kann sich damit per Tablet direkt im Lager bewegen und verschiedene Vorgänge unmittelbar vor Ort durchführen.
Sollen beispielsweise Teile entnommen oder neu eingelagert werden, lassen sich die entsprechenden Artikel einfach erfassen. Auch Informationen zum aktuellen Bestand sind direkt verfügbar – so kann der Mitarbeitende jederzeit prüfen, an welchen Lagerorten sich ein bestimmter Artikel befindet und in welcher Stückzahl dieser dort vorhanden ist.

Auf einen Blick – Alle wichtigen Lagerinformationen direkt verfügbar

• Artikelbestand: Wo befindet sich ein bestimmter Artikel und in welcher Stückzahl ist er an den jeweiligen Lagerorten vorhanden?
• Lagerplatz: Welche Artikel und Mengen befinden sich aktuell auf einem bestimmten Lagerplatz?
• Lagerbewegungen: Historische Lagerbewegungen können jederzeit eingesehen und lückenlos nachvollzogen werden.

Lagerbewegungen direkt erfassen

• Artikel auslagern: Entnommene Artikel direkt erfassen und den Bestand aktualisieren.
• Artikel einlagern: Neue oder zurückgeführte Artikel einem Lagerplatz zuordnen und einbuchen.

Echtzeit-Prozesse statt Old-School-Datenaustausch

Mit API-Schnittstellen werden Daten direkt und in Echtzeit zwischen verschiedenen Systemen ausgetauscht. Statt Informationen manuell zu übertragen oder zeitversetzt zu importieren und exportieren, stehen sie genau dort zur Verfügung, wo sie benötigt werden. Medienbrüche und doppelte Dateneingaben werden reduziert, während Prozesse systemübergreifend automatisiert ablaufen können. Das sorgt für schnellere Abläufe, weniger Fehler und stets aktuelle Informationen – auch über unterschiedliche Anwendungen hinweg. Die OpenAPI bietet die Möglichkeit, CAQ.Net in beliebige Elemente externer Systemlandschaften einzubinden und nahezu jede Funktion von CAQ.Net innerhalb des MES, ERP oder einer individuellen Smartphone-App abzubilden. Notwendige Frontends oder Browser-Apps können dank offener Dokumentation der API komplett selbstständig entwickelt werden.

Die OpenAPI in CAQ.Net ist:

• offen
• standardisiert
• plattformunabhängig und individuell einsetzbar

Die OpenAPI-Spezifikation (OAS) ist eine standardisierte, maschinenlesbare Beschreibung der API. Darin steht beispielsweise, welche Endpunkte und Funktionen es gibt, welche Daten übergeben werden müssen und welche Antworten möglich sind.
Aus dieser OAS kann dann automatisch eine lesbare API-Dokumentation mittels Swagger erzeugt werden .

Was ist eine API-Dokumentation?

Eine API-Dokumentation ist im Grunde die Bedienungsanleitung für eine API. Sie erklärt Entwicklern, wie andere Programme mit der Software kommunizieren können.

• Welche Funktionen verfügbar sind: z. B. Prüfaufträge abrufen, Stammdaten lesen oder Ergebnisse übertragen
• Welche Daten übergeben werden müssen: z. B. Artikelnummer, Prüfauftragsnummer oder Messwert
• Wie eine Anfrage aufgebaut ist: z. B. welche URL bzw. welcher Endpunkt verwendet wird und ob Daten gelesen, erstellt oder geändert werden
• Wie die Antwort aussieht: z. B. welche Daten CAQ.Net als JSON zurückliefert
• Wie die Authentifizierung und Sicherheit umgesetzt werden: z. B. wie sich eine externe Anwendung gegenüber der API legitimiert
• Welche Beispiele und Fehlercodes es gibt: z. B. Beispielanfragen sowie Informationen dazu, was bestimmte Fehlermeldungen bedeuten

Future-Proof

Innerhalb von CAQ.Net besteht hierzu ein kontinuierlich wachsender versionierter Katalog von updatesicheren API-Standardfunktionen, welcher mit jedem Release erweitert wird.