Eine Übersicht der Anwendungsmöglichkeiten, Abläufe und Funktionen
Die um REST organisierte Schnittstelle ist darauf ausgelegt, Funktionen der customX Anwendung zu steuern. Beispielsweise können customX Projekte erstellt, Parameter übergeben und Dokumente erzeugt werden.
Die Schnittstelle wird üblicherweise für zwei Anwendungszwecke genutzt:
- Fernsteuerung der customX Anwendung im Hintergrund häufig zur automatisierten Erzeugung von Dokumenten
- Aufruf der Konfigurationsoberfläche zum Beispiel aus einem Webshop oder Kunden-Portal
Verbindung mit customX im Hintergrund
Über die bidirektionale Schnittstelle können Systeme wie zum Beispiel ein ERP, Konfigurator, Webshop etc. mit customX Verbindung aufnehmen. customX gibt in der Regel einzelne Dokumente oder Parameterinformationen zurück. Ein typischer Programmablauf setzt sich zusammen aus:
- Verbindung zu customX herstellen
- Anmeldung am Webserver
- customX Projekt laden oder neu erstellen
- Parameter übergeben
- Projekt berechnen
- Projekt speichern
- Auftrag zur Erzeugung von Dokumenten geben
- Logout
Aufruf der Konfigurationsoberfläche im Webbrowser
Soll dagegen die customX Konfigurationsoberfläche genutzt werden, kann ein System diese aufrufen und zum Beispiel in der Unternehmenswebsite einbinden. Üblicherweise setzt sich der Vorgang zusammen aus:
- Verbindung zu customX herstellen
- Anmeldung am Webserver
- customX Projekt laden oder neu erstellen
- Parameter übergeben
- Projekt berechnen
- customX Konfigurationsoberfläche aufrufen
Durch einen Auslöser wie beispielsweise der Klick auf einen "In den Warenkorb"-Button werden Informationen oder einzelne Dokumente als Datenstream von customX an das System zurückgegeben.
Übersicht der Schnittstellenfunktionen
Detailliertere Informationen zu den einzelnen Schnittstelleninformationen finden Sie auf den nachfolgenden Seiten.
- Sitzungsfunktionen
- Projektfunktionen
- Navigationsfunktionen
- Bauteilfunktionen
- Parameterfunktionen
- Dokumentfunktionen
Praxisbeispiele
Praxisbeispiele finden Sie in diesem Artikel.