Bericht - 1. August 2022

Interoperabilität: Web-Services schneller umsetzen

CONTACT Elements hat eine leistungsfähige REST API für die Anbindung anderer IT-Systeme und den Datenzugriff auf unsere Softwarelösungen. Nun stellen wir eine Dokumentation bereit, die der OpenAPI-Spezifikation folgt. Sie bietet Kunden und Partnern viele Vorteile.


REST (REpresentational State Transfer) ist ein Kommunikationsansatz für verteilte Softwarearchitekturen, den wir seit Jahren nutzen: für die Interaktion zwischen Client und Server und zur Integration anderer IT-Systeme. REST beschreibt den Aufbau von Programmierschnittstellen, die den Zugriff auf und die Verwendung von Daten über http-Anfragen steuern und ist vor allem erste Wahl für Web- und Cloud-Dienste.

REST APIs dienen unter anderem dazu, (Alt-)Daten zu importieren, Daten für Reports zu exportieren oder Drittsysteme anzubinden. Anwendungsunternehmen und Partner sind in der Regel bei solchen Szenarien auf die Expertise der Softwarehersteller angewiesen, wenn sie Inhouse- und Third-Party-Lösungen mit deren IT-Systemen verknüpfen wollen. Denn die Syntax einer REST API ist zwar definiert, nicht aber die Semantik. Sie setzt das nötige Wissen zum Datenmodell und der Geschäftslogik der jeweiligen Software voraus, um die Schnittstelle zu implementieren.

Neue REST API Dokumentation

Nun stellen wir eine umfangreiche Dokumentation zu unserer REST-Schnittstelle auf Basis der OpenAPI-Spezifikation für Kunden und Partner zur Verfügung. Sie bietet eine standardisierte graphische Oberfläche, die hilft, die Möglichkeiten unserer REST-Dienste intuitiv zu verstehen und diese schnell und ohne tiefere Kenntnisse unserer Technologie einzusetzen.

Die neue Schnittstellenbeschreibung enthält die REST-Ressourcen für CAD-Dokumente, Artikel, Projekte etc. und die entsprechenden Zugriffsmethoden GET, POST, PUT und DELETE. Sie wird automatisch auf Grundlage des Datenmodells von CONTACT Elements erstellt. Die Dokumentation umfasst sowohl die wichtigsten produkt- und projektbezogenen Objekte als auch Verwaltungs- und Konfigurationseinstellungen, wie beispielsweise Klassifizierung, Materialien und Artikelnamen.

Interaktives Testen

Ein großartiges Feature ist, dass Nutzer:innen jede Methode für jede REST-Ressource aus der Dokumentation heraus interaktiv testen können. So lässt sich einfach per Knopfdruck ausprobieren, ob zum Beispiel die GET-Methode auch die Daten liefert, die gewünscht sind. Unsere Kunden sind so in der Lage, selbst ohne viel Aufwand ein Web-Portal, eine Middleware oder ähnliches per REST mit unserer Software zu verbinden.

Die Beschreibung unserer REST-Schnittstelle auf Basis der OpenAPI-Spezifikation wird zuerst im nächsten CONTACT Cloud Release automatisch als Teil der Standarddokumentation bereitgestellt.


Ihr Ansprechpartner

André Guldi
Produktmanager Cloud
 

Wir helfen ihnen gern!
Sprechen Sie mit einem Mitarbeiter:


Standorte