Start >

Schritt 3: Testclient

MonKey Office Connect enthält einen Testclient, welcher die volle Funktionalität von MonKey Office Connect testen kann. Dieser erleichtert Entwicklern den Einstieg in die Programmierung eigener Software, indem die Kommunikation mit MonKey Office Connect verdeutlicht wird. Der Testclient ist kein Bestandteil von MonKey Office Connect. Er ist eine eigene Anwendung, kann aber aus MonKey Office Connect heraus gestartet werden.

Voraussetzungen:

  • In den Einstellungen ist für die Authentifizierung die Option Basic ausgewählt.

  • Für einen ersten Test empfehlen wir, in den Einstellungen unter Sicherheit die Option Kein SSL zu aktivieren.

    Für den realen Einsatz empfehlen wir dringend, die Daten mittels SSL oder TLS zu verschlüsseln.

So überprüfen Sie die Verbindung für einen Benutzerzugang:

  1. Klicken Sie auf Entwicklung > Testclient.
    Der Testclient wird in einem eigenen Fenster geöffnet.

  2. Wählen Sie über die Registerkarten das Datenaustauschformat JSON oder SOAP (Dieses Handbuch wird sich auf JSON als Austauschformat konzentrieren).

  3. Im Textfeld Server ist bereits die JSON-URL zur Kommunikation mit dem aktuellen MonKey Office Connect voreingestellt.

  4. Geben Sie in die Textfelder Login und Kennwort Benutzernamen und Kennwort des autorisierten MonKey Office-Benutzerzugangs der verwendeten Datenbank ein.

  5. Markieren Sie links in der Spalte Bereich den Eintrag API-Info und klicken Sie in der CMD-Liste auf apiInfoGet.

  6. Unter Eingabe wird der JSON-Code angezeigt, welcher an Connect gesendet wird.

  7. Klicken Sie auf CMD ausführen.

  8. Unter Ausgabe wird der JSON-Rückgabecode angezeigt, welcher von Connect zurückgeliefert wird.
    Bei erfolgreicher Konfiguration sollten Sie eine Ausgabe ähnlich der Folgenden erhalten:

    images/download/attachments/19891306/Testclient_MonKey_Office_Connect-_Bereich_API-Info.png

So fragen Sie die Daten ab:

  1. Um Informationen aus der MonKey Office Datenbank in Connect abrufen zu können, muss zunächst eine Firma ausgewählt werden.
    Klicken Sie dazu links auf den Bereich Firmen und in der CMD-Liste auf firmaList.

  2. Klicken Sie auf CMD ausführen.
    Unter Ausgabe wird eine Liste aller freigegebenen Firmen in der Datenbank angezeigt.

  3. Kopieren Sie eine Firmen-ID aus dem Feld Ausgabe in das Feld Key-Firma.

    images/download/attachments/19891306/Testclient_MonKey_Office_Connect-_Bereich_Firmen2.png

  4. Wählen Sie nun den Bereich, aus dem Sie Daten abfragen möchten.
    Klicken Sie z. B. auf den Bereich Adressen und in der CMD-Liste dann auf die enstprechende Liste, in unserem Beispiel adresseList(mit Filter).

  5. Klicken Sie auf CMD ausführen.
    Unter Ausgabe wird eine Liste aller Adressen der ausgewählten Firma angezeigt.

  6. Um die weiteren Informationen zu einem Datensatz abzurufen, müssen Sie nun die ID des Datensatzes übergeben.
    Kopieren Sie dazu eine Adress-ID in die Abfrage im Eingabefeld.

    images/download/attachments/19891306/Testclient_MonKey_Office_Connect-_Bereich_Adressen2.png
  7. Klicken Sie in der CMD-Liste auf adresseGet(mit ID).
    Die ID wird automatisch in den Eingabecode integriert.

  8. Klicken Sie auf CMD ausführen.
    Im Feld Ausgabe werden nun die detaillierten Informationen zu der gesuchten Adresse angezeigt.

Code ändern

Sie können im Feld Eingabe auch eigene Änderungen am JSON-Code vornehmen, z. B. Adressdaten zum Ändern in den entsprechenden JSON-Feldern modifizieren.

Bei komplexeren Anfragen ist es wünschenswert, Teile des Ausgabefensters als Eingabe zu verwenden. Ein solcher Fall wäre die Verwendung von Filtern für Auflistungen. Dazu wurde im Testclient ein Mechanismus zur Vereinfachung dieses Vorgangs implementiert. Als Beispiel ist hier eine Adressen-Auflistung mit Filter beschrieben.

So ändern Sie den Code:

  1. Wählen Sie wie zuvor beschrieben eine Firma aus und setzen Sie die Firmen-ID in das Feld Key-Firma ein.

  2. Wechseln Sie in den Bereich Adressen, wählen Sie den Befehl adresseFilterTemplate aus klicken Sie auf CMD ausführen.
    Im Ausgabefenster wird die Datenstruktur des Adressfilters angezeigt.

  3. Wählen Sie in der CMD-Liste die Funktion adresseList(mit Filter) aus.

  4. Im Eingabefenster wird die Filterstruktur übernommen, diese können Sie nun anpassen (z. B. den Suchtext ändern).

  5. Klicken Sie auf CMD ausführen, um die gefilterte Adressliste anzuzeigen.

Ähnlich funktionieren adresseTemplate und adresseAdd(mit template).

Für einige Funktionen sind auch mehrere Testclient-Fenster sinnvoll. Sie können einen Bereich in einem neuen Fenster öffnen, indem Sie ihn mit gedrückter <cmd>- bzw. <Strg>-Taste anklicken. Die Firma- und Wirtschaftsjahreinstellung sowie die Anmeldedaten werden dabei übernommen.

Nächstes Thema: