Zum Inhalt

GraphQL - Einführung in das Thema und technische Dokumentation

Gen. 24 Enterprise

Was ist GraphQL (generelle Informationen)?

Frei übersetzt von der Website der "GraphQL Foundation": "GraphQL ist eine Abfragesprache für APIs und eine Laufzeitumgebung für die Erfüllung dieser Abfragen mit Ihren vorhandenen Daten. GraphQL bietet eine vollständige und verständliche Beschreibung der Daten in Ihrer API, gibt Anwendern die Möglichkeit, genau das abzufragen, was sie benötigen, und nicht mehr, erleichtert die Weiterentwicklung von APIs im Laufe der Zeit und ermöglicht leistungsstarke Entwicklerwerkzeuge."

Dadurch bietet es eine flexible und effiziente Möglichkeit, Daten aus der microtech Software über eine Schnittstelle abzufragen und zu analysieren.

Grundlegendes Konzept der Schnittstelle

Video Vorschau
▶ Video abspielen
Beachten Sie: Durch den Klick auf das Bild wird das Video geladen und Daten an YouTube übertragen.
Mehr Infos

Vorteile von GraphQL

Der wesentliche Vorteil von GraphQL liegt in der Einfachheit der Abfragen und der Präzision der Antworten. GraphQL liefert auf eine Abfrage exakt die angeforderten Daten; nicht benötigte Informationen werden weder geladen noch ausgegeben. Dies resultiert in einer hohen Performance bei Abfragen und Antworten, selbst bei großen Datenbanken. Das Schema ist klar strukturiert und für Entwickler gut verständlich.

FAQ von der GraphQL Foundation

Eine FAQ zu GraphQL finden Sie an dieser Stelle im Internet: Externer Link: https://graphql.org/faq/

Die Funktionsweise und generelle Anwendung von GraphQL ist auf dieser Seite der Foundation im Internet dokumentiert: Externer Link: https://graphql.org/learn/

Wofür verwendet microtech GraphQL?

Die GraphQL-Schnittstelle bildet einen essenziellen Baustein auf unserem Weg in die Cloud. Sie schafft eine einheitliche, zukunftssichere Zugangsschicht, über die unsere Software auch über das Internet genutzt werden kann. Damit legen wir die Grundlage für maximale Vernetzung, Sicherheit, Skalierbarkeit und Performance. Sie löst die COM-Aktiv-Schnittstelle ab und ermöglicht es unseren Partnern und Anwendern, mit modernen Technologien Lösungen für ihre Herausforderungen zu entwickeln.

Info

In diesem Bereich unserer microtech Hilfe erhalten Sie:

  • Einführende Informationen für Anwender der Software

  • Eine umfangreiche Entwickler-Dokumentation.

  • In der OAuth 2.0 API-Dokumentation erfahren Sie in den ersten drei Kapiteln, welche Schritte für das Anbinden von Anwendungen in microtech büro+ notwendig sind. Im weiteren Verlauf der OAuth 2.0 API-Dokumentation erhalten Sie weiterführende technische Details.

  • Informationen dazu, wie Freie Datenbank-Tabellen über GraphQL erreichbar gemacht werden, finden Sie unter Freie Datenbank-Tabellen über GraphQL nutzen.

Wie wird der GraphQL-Server in der microtech Software gestartet?

Die microtech Software stellt GraphQL-Endpunkte automatisch bereit, sobald GraphQL für einen Mandanten aktiviert wird. Eine manuelle Einrichtung von Automatisierungsdiensten ist dafür nicht erforderlich.

Ausführliche Informationen zur Einrichtung, URL-Struktur und Statusübersicht finden Sie unter GraphQL-Endpunkt - Einrichtung und Betrieb.

Info

Alternative: Manuelle Einrichtung über einen Automatisierungsdienst

Der GraphQL-Server lässt sich weiterhin manuell über einen Automatisierungsdienst einrichten. Dieser Weg wird nur noch benötigt, wenn die automatische Bereitstellung nicht genutzt werden kann; beide Varianten können parallel betrieben werden.

Der Graph-QL Server wird im Bereich der Automatisierungs-Dienste eingerichtet. Unter MEINE FIRMA - ÜBERBLICK - Register: AUTOMATISIERUNGS-DIENSTE wird der GraphQL-Server eingerichtet und verwaltet.

Weitere Infos:

An welcher Stelle in der microtech Software werden Anwendungen verwaltet?

Das Verwalten der Anwendungen erfolgt innerhalb der Software unter MEINE FIMRA - ÜBERBLICK - Register: ÜBERBLICK - Gruppe: SYSTEMEINSTELLUNGEN - ANWENDUNGEN VERWALTEN.

Auf dem Register: ANWENDUNGEN lassen sich Anwendungen hinzufügen und verwalten.

In unserer OAuth 2.0 API-Dokumentation erhalten Sie eine Einführung in das Thema OAuth 2.0 in Zusammenhang mit microtech büro+ und der Nutzung von Anwendungen über diese API. Im Kapitel Anwendung einrichten (OAuth-Client) erhalten Sie auf dieser Seite eine Benutzerdokumentation, welche die Einrichtung der Anwendungen in der Software beschreibt. Für erfahrene Anwender und insebsondere Entwickler finden Sie innerhalb dieser Dokumentation weitere technische Details und Hinweise zur API.

Übersicht über dieses Kapitel

In diesem Kapitel erhalen Sie wertvolle Grundlagen für die Nutzung der GraphQL-Schnittstelle.

Grundlagen und Einstieg

Authentifizierung und Zugriff

KI-Integration

Praxisbeispiele

Vorgänge

Funktionsreferenzen und Parameter