Allgemeine Informationen
Die xpecto OpenData XML-API ist ein Web-Service zur Übermittlung von Daten an die xpecto-Datenbank (Upload) und zur Abholung von Daten von der xpecto-Datenbank (Download). Der Aufruf von Client-Seite erfolgt über das HTTP-Protokoll durch POST der Übertragungs-Parameter indem eine Zip-Dateiordner ein JSON übertragen wird. Die API kommuniziert direkt mit dem xpecto Datenbanksystem auf Basis des Umwandelns des xml im Zip-File in die einzelnen Datensätze. Mit einem Aufruf können jeweils nur Kundendaten, Vertrags und Kundendaten, Vermittlerdaten oder Complience-Daten übertragen werden. Der Web-Service kann nur vom Programmcode aus aufgerufen werden. Es werden Zugangsdaten (Benutzername, Passwort, Client-ID) benötigt. Diese erhalten Sie von xpecto. Die Generierung von IDs für zu übermittelnde Datensätze werden beim Kundensystem eingestellt. So können einzelne ID-Patterns für Vertrags, Kunden und Vermittlerdatensätze angelegt werden. Diese legt xpecto an und diese sind dann mit dem mitgeteilten Benutzer verknüpft.
Einrichtung
Folgen Sie bitte den hier aufgelisteten Schritten zur Einrichtung Ihrer Schnittstelle zwischen portagon go und xpectoPro.
Schritt 1: Status der Lizensierung
Die Nutzung des OpenData Moduls ist kostenpflichtig auf Seiten von xpecto. Sofern dieses Modul erworben wurde, haben Sie als Nutzer die Möglichkeit auf den OpenData Menüeintrag zu drücken (siehe unten). Falls dies nicht möglich ist, kontaktieren Sie bitte Ihren Ansprechpartner bei xpecto, da ggf. zur Freischaltung der Funktionalität eine separate Lizenz bei xpecto erworben werden muss.
Schritt 2: Anlegen eines neuen OpenData-Users
Nach dem Klick auf OpenData öffnet sich die Haupt-Benutzeroberfläche. Hier wechselt man in den Reiter "Übersicht und Konfiguration", in der ein neuer OpenData-User angelegt werden kann.
Hierzu erfasst man einen Benutzernamen, ein Passwort sowie einen eindeutigen OpenDataOwner. Der OpenDataOwner dient dazu, den Einlieferer eindeutig zu definieren und weitere detaillierte Einstellungen zu den einzelnen Komponenten des Users vorzunehmen.
Bitte notieren Sie sich Ihre Einstellungen für Schritt 4 & 5.
Nach Klick auf OpenData-User erstellen ist dieser User sofort zur Auswahl verfügbar. Nachdem der User angelegt wurde, muss dieser noch an den Webserver synchronisiert werden.
Schritt 3: Produkte definieren
Wählt man nun den soeben erstellten OpenDataOwner aus, können noch die Produkte definiert werden, zu denen Vertragsdaten übermittelt werden dürfen. Ohne eine Auswahl eines Produktes können ausschließlich Kunden- bzw. Vertriebspartnern-Daten übermittelt werden.
Schritt 4: Informationen zur Authentifizierung sammeln
| Feldname | Beschreibung |
| Anmeldename | Anmeldename des OpenData Users aus Schritt 2. |
| Passwort | Passwort des OpenData Users aus Schritt 2. |
| License Key | Lizenzdaten für den Betrieb der Software (siehe unten) |
| Open Data Owner | Name des OpenData Users aus Schritt 2. |
| API URL | URL des OpenData Users aus Schritt 2. |
Ihren License Key finden Sie in den erweiterten Einstellungen Ihres xpecto Systems. Folgenden Schritte führen Sie zu den relevanten Informationen.
Drücken Sie auf Einstellungen unter dem System Reiter.
Danach drücken Sie auf "erweiterte Einstellungen anzeigen".
Kontaktieren Sie Ihren Ansprechpartner bei xpecto sofern Sie Hilfe benötigen.
Schritt 5: Eingabe der Informationen in portagon go
Gehen Sie unter Einstellungen auf den Punkt "Integrationen" und drücken Sie auf die "Mehr erfahren" auf der Xpecto Kachel.
Drücken Sie auf "Einrichtung".
Geben Sie die relevanten Daten aus Schritt 4 ein und drücken Sie "Integration einrichten".
Für mehr Informationen zur xpectoPro OpenData Schnittstelle besuchen Sie die Dokumentation von xpecto unter: https://service.xpecto.com/help/xpectopro/OpenData.html