Kontor Link / Handbuch shakehands Kontor Link
JSON-Sprachreferenz anzeigen
So zeigen Sie die JSON-Sprachreferenz an:
- Klicken Sie im Navigator auf Entwicklung>JSON-Referenz, um die eigene shakehands Kontor Link - JSON-Sprachreferenz aufzurufen. Die Sprachreferenz enthält die Syntaxinformationen der verwendeten Datenstrukturen und die Funktionen in JSON.
(JSON-Referenz Release 20.1.0, Apple macOS)
(JSON-Referenz Release 15.1.0, Apple macOS)
Möchten Sie Daten in shakehands Kontor nicht nur lesen sondern ändern und löschen, brauchen Sie einen Versionskey. Der Versionskey erkennt ob der Datensatz schon von Dritten in Bearbeitung wird.
Der Funktionsaufruf erfolgt via http(s)://ipdresse:port/shakehandsLinkJSON. Die Parameter werden per POST übertragen. Es können beliebige Programmiersprachen, welche Kommunikationsmöglichkeiten via HTTP/HTTPS unterstützen, genutzt werden. Alle Zugriffe erfolgen zustandsfrei. Für eine vereinfachte Benutzung steht eine PHP-Library für den Zugriff via PHP zur Verfügung. Diese kapselt die eigentliche Kommunikation.
Beachten Sie die Details in der Maske. Viele Funktionen sind nur mit einem definierten Key der Firma möglich. Dieser wird beim Aufruf der Funktion im HTTP-Header (Bezeichner ist mbl-ident) übermittelt. Informationen zur Verwendung findet man in den mitgelieferten Beispiel-Anwendungen. Der Firma-Key wird über die API-Funktion firmaList im Modul Firmen ermittelt.
Es stehen Funktionen zum Anlegen Löschen, Auflisten (optional gefiltert) von Datensätzen zur Verfügung. Zum vereinfachten Anlegen von Datensätzen können Templates genutzt werden und mit den gewünschten Daten gefüllt werden. Einige Bereiche besitzen auch Funktionen zum modifizieren von Datensätzen, bzw. zur Erzeugung von Vorschauansichten.
Mit Hilfe des integrierten Testclient können alle Funktionen simuliert werden. Eine PHP-Library steht für den Zugriff zur Verfügung. Das ist, gerade für den Einstieg, sehr hilfreich. Der Testclient zeigt die Datenstrukturen für Funktionsaufrufe, und die resultierenden Response-Werte. Bei Problemen kann so der Datenfluss analysiert werden. Bei einigen Funktionen werden auch Testdaten generiert um die Einarbeitung zu vereinfachen.
Um diese Referenz im Browser zu öffnen diese URL verwenden: http://127.0.0.1:8084/jsonhelp
Nächstes Thema: