CMI API - auf CMI-Daten zugreifen
Editieren Sie CMI-Daten in Ihrer eingesetzten Software
So setzen Sie das CMI API ein
Möchten Sie die Daten und Dokumente Ihrer Drittapplikation im revisionssicheren DMS von CMI führen? Oder die Inhalte Ihres CMI für andere Umsysteme verfügbar machen?
Das neue CMI API, das den neuesten .NET-Core-Standards entspricht, bietet Ihnen einfach und schnell Zugriff auf die CMI-Daten, die Sie für Ihre tägliche Arbeit benötigen.
Ihr Mehrwert
- Unterstützung des kundenspezifischen Parameterfiles (KPF), womit Sie auch auf Ihre individuellen Datenfelder zugreifen können
- Anbindung zu strategischen Partnern (z. B. Diartis)
- Binden Sie Ihre Drittapplikationen an CMI an und nützen aus dieser die CMI-Funktionen für Ihre Use-Cases
- Der CMI Security Token Service nach neuesten Authentication- und Authorization-Standards sorgt für hohe Sicherheit
- Ihre vorhandene Berechtigungslogik wird auch beim CMI API berücksichtigt
FAQ
Die CMI API ist die offene REST-Schnittstelle für den sicheren und standardisierten Datenaustausch zwischen der CMI Lösungsplattform und Drittanwendungen. Sie nutzt Standard-HTTP-Methoden (GET, POST, PUT, DELETE) und ermöglicht es, CMI-Daten aus Ihrer eingesetzten Software heraus zu lesen, zu erstellen und zu bearbeiten.
Sie können Daten und Dokumente aus Drittapplikationen im revisionssicheren DMS von CMI führen oder CMI-Inhalte für andere Umsysteme verfügbar machen. Typische Szenarien sind die Anbindung von Fachlösungen, das automatisierte Erstellen von Dossiers aus Portalen oder der bidirektionale Datenaustausch mit Partnersystemen.
Die CMI API besteht aus zwei Modulen: Das Model-Modul ermöglicht die generische Erstellung von Endpunkten durch Konfiguration von Typdefinitionen und Feldern. Das Prozess-Modul bildet spezifische Geschäftsprozesse durch vordefinierte Gruppen von Endpunkten ab, etwa für Workflows oder die Prozessautomatisierung.
Die CMI API unterstützt das Erstellen, Bearbeiten, Suchen und Löschen von Geschäften sowie das Aus- und Einchecken von Dokumenten. Zusätzlich können Sie Menüaktionen auf Objekten ausführen (z. B. Abschliessen oder Stornieren) und mit der Abfragesprache TentaQL gezielt nach Daten suchen.
Die Authentifizierung erfolgt ausschliesslich über den CMI Security Token Service (STS). Externe Systeme beziehen ein Bearer Token beim STS und senden dieses bei jedem Aufruf mit. Die bestehende Berechtigungslogik der CMI Lösungsplattform wird vollständig berücksichtigt, sodass Benutzer:innen nur auf Daten zugreifen können, für die sie berechtigt sind.
Ja. Über die Konfigurations-Oberfläche (ConfigUI) legen Sie fest, welche Typdefinitionen (z. B. Geschäft, Dokument, Kontakt) und welche Felder zur Verfügung stehen. Sie können auch bestimmen, ob Felder nur lesbar oder auch beschreibbar sind. So behalten Sie die volle Kontrolle über den Zugriff.
Ja. Die CMI API unterstützt das kundenspezifische Parametrierungsfile (KPF). Damit können Sie auch auf individuelle Datenfelder zugreifen.
Die CMI API wird mit Swagger ausgeliefert. Darüber können Entwickler:innen sämtliche Endpunkte einsehen, die verfügbaren Parameter prüfen und Requests direkt im Browser testen. So ist eine effiziente Entwicklung und Fehlersuche gewährleistet.
Sie benötigen einen CMI STS ab Version 3.0.1 und einen CMI Server ab Version 22.0. Die CMI API verfügt über eine eigene Lizenz, die über die CMI Lösungsplattform aktiviert wird. Sie ist sowohl On-Premises als auch in der CMI Cloud einsetzbar.
Die CMI API ist die strategische, standardisierte REST-Schnittstelle für Drittanwendungen. Im Gegensatz zu älteren Ansätzen wie dem Webservice KPF (SOAP-basiert) bietet sie eine kontrollierte Endpunktkonfiguration, moderne Authentifizierung über STS und eine interaktive Swagger-Dokumentation. Für spezifische Integrationen (z. B. Einwohnerkontrolle, Signaturdienste, eBau) bestehen weiterhin dedizierte Fachschnittstellen.