Einleitung
Die CMI API ist eine zentralisierte Schnittstelle, die speziell für die CMI Lösungsplattform entwickelt wurde, um den Austausch von Daten zwischen verschiedenen Systemen zu erleichtern. Diese API basiert auf den gängigen REST-Konventionen, was bedeutet, dass sie eine vorhersehbare und konsistente URL-Struktur nutzt und Standard-HTTP-Methoden wie POST, GET, PUT und DELETE verwendet. Zusätzlich kommen die gängigen HTTP-Statuscodes zum Einsatz, um den Status von Anfragen klar und eindeutig zu kommunizieren.
Hauptmerkmale der CMI API:
- Generisch und Konfigurierbar: Die API ist so gestaltet, dass sie sehr flexibel und anpassbar ist. Sie kann auf verschiedene Arten konfiguriert werden, um die spezifischen Anforderungen der CMI Lösungsplattform zu erfüllen.
- Standardisierte Schnittstelle: Die API bietet eine standardisierte Möglichkeit, mit der CMI Plattform zu interagieren, sodass Entwickler auf eine einheitliche Weise Daten manipulieren können.
- Kontrolle und Sicherheit: Mit der API kann präzise gesteuert werden, welche Objekttypen zugänglich sind und welche Aktionen (z.B. Lesen, Erstellen, Löschen) auf diesen Objekttypen durchgeführt werden dürfen. Dies ermöglicht eine feingranulare Kontrolle, die es ermöglicht, den Zugriff auf sensible Daten zu regeln und die Integrität der Plattform zu wahren.
Insgesamt ist die CMI API ein leistungsstarkes Werkzeug, das die Entwicklung und Integration von Anwendungen mit der CMI Lösungsplattform vereinfacht und gleichzeitig eine hohe Flexibilität und Kontrolle bietet.
Integration
Installation
Damit die CMI API verwendet werden kann, muss diese in der Betriebsumgebung installiert werden. Die Anleitung ist unter folgendem Link auffindbar.
Konfiguration
Die ConfigUI ist die Konfigurationsoberfläche der CMI API. - ConfigUI
Dokumenation & Testing
Dokumentation und Tests der Endpunkte innerhalb der CMI API erfolgen über Swagger. - Swagger
Aufbau
Die Beschreibung erklärt, wie die CMI API strukturiert ist und wie ihre Module funktionieren. Es gibt zwei Hauptmodule: das Model-Modul und das Prozess-Modul.
Model-Modul
- Funktion: Das Model-Modul ermöglicht es, Endpunkte generisch aufzubauen, indem Typdefinitionen und Felder zusammengeklickt werden. Dies bedeutet, dass man verschiedene Datenstrukturen (Modelle) definieren kann, die dann automatisch entsprechende API-Endpunkte generieren.
- Flexibilität: Für jede ausgewählte Typdefinition werden automatisch passende Endpunkte erstellt, was den Entwicklungsprozess vereinfacht und beschleunigt.
- Weitere Details: Die spezifische Funktionsweise und weitere Informationen sind hier in der gesonderten Dokumentation beschrieben.
Prozess-Modul
- Funktion: Das Prozess-Modul bietet die Möglichkeit, Prozess-Layer auszuwählen, die vordefinierte Gruppen von Endpunkten bereitstellen. Dies ist besonders nützlich, um spezifische Geschäftsprozesse abzubilden.
- Spezialisierung: Durch die Auswahl passender Endpunkte können individuelle Geschäftsprozesse abgebildet werden, was das Prozess-Modul zu einem wichtigen Werkzeug für die Anpassung der API an spezifische Anforderungen macht.
- Weitere Details: Die spezifische Funktionsweise und weitere Informationen sind hier in der gesonderten Dokumentation beschrieben.
Zusammengefasst ist das Model-Modul für die generische Erstellung von Datenendpunkten verantwortlich, während das Prozess-Modul für die Abbildung spezifischer Geschäftsprozesse durch die Auswahl vordefinierter Endpunkte zuständig ist.
Sicherheit
Um die Zugriffssicherheit zu gewährleisten, kann ausschlisselich mittels authezifizierung am STS (Security Token Service) auf die CMI API zugegriffen werden. Weiterführende Informationen sind hier zu finden.
Die CMI API verfügt über eine eigenständige Lizenzierung. Die Lizenzierung erfolgt über die CMI Lösungsplattform.
Change-Log
Im Change-Log sind sämtliche Anpassungen und Erweiterungen an der CMI API dokumentiert.