Menu

Kontor Link

Application-Programming-Interface (API)

shakehands Kontor Link ist ein universales Application-Programming-Interface (API) für definierte Zugriffsmethoden von eigener Middleware für den Datenaustausch mit und von shakehands Kontor

     Mit shakehands Kontor Link binden Sie die shakehands Kontor Lösung an einen eigenen Webshop, an ein eigenes CRM-Tool, an eigene Warenwirtschaftsysteme, oder an andere Datenbank an. 

    Sie automatisieren zum Beispiel das Verarbeiten von Bestellungen, oder den automatischen Abgleich von Adressdaten, der Offenen Posten oder sie exportieren die Lagerbestände an die externe Logistikapplikationen für Dritte, oder rechnen die Leistungen aus mobilen Applisten ab. Denkbar sind auch Anbindungen für die erweiterte Ausgabe an betriebswirtschaftliche Analyse-Tools oder an mobile Apps für Smartphones und vieles mehr.

    Tauschen Sie über diese Schnittstelle alle möglichen Daten automatisch ab und integrieren Sie andere Lösungen. 

    shakehands Kontor Link ermöglicht Ihnen als Entwickler:in oder Betreiber:in einer externen Dritt-Software den direkten Zugriff auf die shakehands Kontor Daten, deren Listen und Funktionen. 

     Der Zugriff erfolgt über die Kommunikation von shakehands Kontor Link mit dem von shakehands Kontor verwendeten Datenbankserver cubeSQL. shakehands Kontor Link erlaubt das Abfragen von Daten, das Filtern von bestimmten Informationen, das Ändern von bestehender Datensätze und das Anlegen und Schreiben von neuen Datensätze. 

   shakehands Kontor Link verwendet zur Sicherung der Datenbankkonsistenz die Geschäftslogik - Business Rules von shakehands Kontor. 

    Welche Bereiche in der shakehands Kontor Datenbank über shakehands Kontor Link erreichbar sind, ist vordefiniert und wird in der Dokumentation beschrieben. Der Zugriff auf Link erfolgt über das Übertragungsprotokoll HTTPS.


Eigene Middleware entwickeln

Entwickeln Sie mit shakehands Kontor Link eigene Anwendungen.

    Einige Beispiele: Sie haben einen Webshop und möchten Artikel und Adressen mit dem Artikelstamm und den Bestandesmengen in shakehands Kontor abgleichen. Diese Aufgabe kann via die API erledigt werden. Oder Sie möchten die Bestellungen des eigenen Webshop digital in shakehands Kontor  übergeben um dort diese Daten für eine neue Bestellung oder gleich als neue Rechnung einzutragen, dabei soll die Adresse abgeglichen oder neu erstellt werden und alle Positionen der Rechnung erstellt werden und am Schluss Beleg und QR-Zahlteil erstellt werden.

   Oder Sie haben ein eigenes Analyse-System für die Überwachung von Projekten und möchten Daten aus der shakehands Kontor Buchhaltung  auslesen, um damit eigene erweiterte Liquiditätspläne oder Budgets in ihrem System zu überwachen. 

    Oder Sie erfassen in einer mobilen Leistungserfassung-App auf dem mobilen Smartphone oder Tablet die Abrechnungen und Leistungen von Kunden und möchten diese Daten gleich als Positionen im neuen Rechnungsbelege in shakehands Kontor übertragen lassen. 

    Oder Sie haben eine eigene CRM-Lösung und möchten die Basisdaten der Adressen, Bankdaten und weiteren Adressinformationen mit shakehands Kontor abgleichen um hier die Rechnung zu erstellen.

    All dies sind mögliche Lösungen, die unsere Kunden mit der shakehands Kontor Link API umgesetzt haben, So sind viele weitere Drittanwendungen denkbar und auf diese Weise in das Rechnungswesen uzt integrieren.    

Lieferumfang

shakehands Kontor Link ist eine Schnittstelle (API) zur Kommunikation mit einer von Ihnen zu entwickelnden Software (Middleware) die das JSON Protokoll nutzt. 

shakehands Kontor Link umfasst als Paket dabei:

  • einen konfigurierten Server zur Kommunikation mit der eigenen Middleware
  • einen Test-Client zur Darstellung der Funktionen und Kommunikation mit der Datenbank
  • Code-Beispiele einer Web-App für Datenabruf und Datenänderung 
  • eine integrierte Dokumentation der Methoden, Klassen und Eigenschaften und Funktionen
  • eine allgemeine Online Dokumentation shakehands Kontor Link
  • PHP- und C++-Bibliotheken mit Methoden

Voraussetzungen und Entwickler:in

Es gibt einige notwendige Voraussetzungen die erfüllt sein müssen für das Entwickeln der Schnittstelle, der Middleware. Sie brauchen:

  • aktive shakehands Kontor Lizenz
  • shakehands Kontor Datenbank, die auf dem cubeSQL Server läuft
  • einen cubeSQL Server mit aktiver Lizenz
  • eine Drittdatenbank, die mit shakehands Kontor Link und der zu entwickelnden Middleware zusammen arbeitet

   Zu beachten ist, dass shakehands Kontor und shakehands Kontor Link die gleiche Versionierung aufweisen und die cubeSQL Server Version für diese Versionen freigeben ist. 

    Sie brauchen eine eigene Entwicklerin oder einen Entwickler, die die Middleware programmiert, wenn Sie selber diese Voraussetzung nicht mitbringen. Oder Sie beauftragen eine Partnerin oder einen Partner mit einem Programmierauftrag um eine eigene Schnittstelle für Ihr Projekt zu realisieren. 

Werkzeug

shakehands Kontor Link ist keine Endanwendung, die mit wenigen Klicks installiert ist und vom Enduser oder der Enduserin sofort in Betrieb genommen werden kann. Sie erhalten von ShakeHands Software Ltd keine fertige Kommunikationslösung. 

    Die konkrete Implementierung einer Schnittstelle zwischen den Applikationen bleibt Ihnen vorbehalten rsp. muss von Ihnen in einem Projekt beauftragt und programmiert werden. Die Funktionalität von shakehands Kontor Link kann nicht erweitert werden. Wünsche und Anregungen werden von uns gerne entgegen genommen, diskutiert und eventuell in zukünftigen Versionen integriert.

    Für die Zeit der Entwicklung erhalten Sie oder Ihre Entwicklungspartnerin auf Anfrage eine kostenlose Developer-Lizenz.

Das Lizenzmodell

    shakehands Kontor Link ist als Client-/Server Applikation für shakehands Kunden frei lizenzierbar.    

     shakehands Kontor Link ist kostenlos. Sie benötigen zum Einsatz der Software eine persönliche Lizenznummer. Dies für die Entwicklerversion und später für die produktive Version. 

     Bestellen Sie die Lizenzen im shakehands Shop. Registrieren Sie bitte die Lizenz. Für den späteren produktiven Einsatz von shakehands Kontor Link brauchen Sie eine gültige und registrierte shakehands Kontor Ausführung.

    Für die Entwicklung der Middleware und während der Entwicklungszeit erhalten Sie eine kostenlose Entwicklerlizenz (DEV-Lizenz). 

     Bestellen Sie diese ebenfalls im Shop. Entwicklerlizenzen sind zeitlich auf 90 Tage begrenzt. Für eine Verlängerungen über dies Zeit hinweg, wenden Sie sich an unseren Support. Bei der Bestellung stellen wir einige Fragen zu Ihrem Entwicklungsprojekt, damit wir allfällige andere Kundenanfragen auf laufende Projekte hinweisen können. Wir kommunizieren diese an unseren Kundenstamm oder unterhalten eine Anfrageliste für weitere oder ähnliche Projekte.Damit kann unsere shakehands Commons sich austauschen.

    Supportleistungen, die über die produktbezogenen Fehlerbehebungen hinausgehen, z.B. für Analyse, Beratungen, Consulting oder Services für die Middleware-Programmierung oder für Schulungen, verrechnen wir zu den aktuellen Servicetarifen. Einführungsschulungen sind möglich. 

Entwicklen Sie die eigene shakehands App!


API kostenlose ErweiterungBestellen

Beispiele

    Beispiele und mögliche Einsatz-Szenarien für shakehands Kontor und shakehands Kontor Link sowie der eigenen Middleware und der Fremdapplikation sind vielfältig:

  • Sie haben einen Webshop und möchten Artikel und Adressen in Ihren Webshop abgleichen,
  • Sie möchten Webshop-Bestellungen aus Ihrem Shopsystem in shakehands Kontor zur Rechnungsstellung übergeben.
  • Sie haben ein eigenes Analyse-System und möchten Daten aus shakehands Kontor automatisch auslesen.
  • Sie erfassen in einer mobilen Leistungserfassung-App auf dem Smartphone oder dem iPad die Grunddaten von externen Serviceleistungen, die Sie später im Büro zurück in eine Kundenrechnung erfassen möchten.
  • Sie haben ein CRM-System und möchten die Stammdaten der Adressen mit shakehands Kontor abgleichen.
  • Viele weiter Drittanwendungen sind umgesetzt.

Update Informationen

Funktionen (Release 19.2 unterstützt shakehands Kontor 19.3. und 19.2)

  • [Allgemein] Änderung DB/API Schema auf Version 98

Funktionen (Release 19.1 unterstützt shakehands Kontor 19.1.)

  • [Allgemein] Änderung DB/API Schema auf Version 97
  • [Adressen] Adressen mit Steuergebiet EU-Ausland können nicht angelegt werden - korrigiert

Funktionen (Release 19.0 unterstützt shakehands Kontor 19.0. intern)

  • [Verkauf] Neue Funktion verkaufbelegModify zur Änderung bestimmter Parameter in (noch nicht weitergeleiteten) Belegen
  • [Verkauf] Unterstützung Parameter VersandURL in VerkaufbelegAddItem, VerkaufbelegItem
  • [Einkauf] Neue Funktion einkaufbelegModify zur Änderung bestimmter Parameter in (noch nicht weitergeleiteten) Belegen
  • [Einkauf] Unterstützung Parameter VersandURL in EinkaufbelegAddItem, EinkaufbelegItem
  • [Artikel und Leistungen] Erweiterung Filterparameter um aktuelle Bestandsdaten
  • [Lager] Erweiterung Filterparameter um aktuelle Bestandsdaten

Funktionen (Release 18.5 unterstützt shakehands Kontor 18.5.)

  • [Allgemein] Änderung DB/API Schema auf Version 95
  • [Allgemein] Verbesserung Darstellung/Benutzbarkeit der JSON-Referenz
  • [Artikel und Leistungen] Neuer Kontoparameter EKontoAnzEUOSS in warengruppeAdd, warengruppeGet

Funktionen (Release 18.4 unterstützt shakehands Kontor 18.4.)

  • [Allgemein] Änderung DB/API Schema auf Version 94
  • [Allgemein] Farbfehler bei PDF-Erzeugung - behoben
  • [Artikel & Leistungen] Unterstützung Bildformate BMP,PNG,JPG in artikelBildGet
  • [Verkaufsbelege] Filterparameter VorbelegStatus ersetzt MitVorbelege (MitVorbelege entfällt ab 19.0)
  • [Verkaufsbelege] Filterparameter FolgebelegStatus ersetzt MitFolgebelege (MitFolgebelege entfällt ab 19.0)
  • [Verkaufsbelege] Unterstützung Feld AUF_QRIBAN in Druckformularen
  • [Verkaufsbelege] Fehler Beschreibung und Preis werden nicht automatisch aus Stammartikeln übernommen - beseitigt
  • [Einkaufsbelege] Filterparameter VorbelegStatus ersetzt MitVorbelege (MitVorbelege entfällt ab 19.0)
  • [Einkaufsbelege] Filterparameter FolgebelegStatus ersetzt MitFolgebelege (MitFolgebelege entfällt ab 19.0)
  • [Einkaufsbelege] Fehler Beschreibung und Preis werden nicht automatisch aus Stammartikeln übernommen - beseitigt
  • [Buchungen] Automatische Erzeugung Belegnummer (bei nichtgesetztem Parameter BelegNr) in buchungAdd
  • [Debitoren] Automatische Erzeugung Belegnummer (bei nichtgesetztem Parameter BelegNr) in debitorenRechnungAdd
  • [Kreditoren] Automatische Erzeugung Belegnummer (bei nichtgesetztem Parameter BelegNr) in kreditorenRechnungAdd

Funktionen (Release 18.1 unterstützt shakehands Kontor 18.1.)

  • [Firmen] Datentyp FirmaItem neue Ausgabe von IBAN und BIC, dafür entfallen alte Kontonummer und BLZ
  • [Adressen] Unterstützung von RA-Strasse, RA-StrasseNr in Adresslist
  • [Verkaufsbelege] Neuer Parameter optional SepaBankeinzugin VerkaufsbelegItem und VerkaufsBelegAddItem

Funktionen (Release 17.2 unterstützt shakehands Kontor 17.2.)

  • [Allgemein] Ausgabe von User-Rechten

Funktionen (Release 17.0 unterstützt shakehands Kontor 17.0.)

  • [Verkauf] Neuer Parameter BearbeiterAngeben in Verkaufsbelegen
  • [Einkauf] Neuer Parameter BearbeiterAngeben in Einkaufsbelegen
  • [Debitoren] Neuer Parameter Entwurf in Debitorenrechnungen
  • [Kreditoren] Neuer Parameter Entwurf in Kreditorenrechnungen
  • [Attachement] Neuer Parameter Bezeichnung hinzugefügt

Funktionen (Release 16.3 unterstützt shakehands Kontor 16.3.0)

  • [Sonstiges] Apple macOS Catalina Freigabe

Funktionen (Release 16.2 unterstützt shakehands Kontor 16.2.1)

  • [Verkauf] Unterstützung Bankkonto in Auftrag
  • [Adressen] Unterstützung Ansprechpartner Kontaktrolle
  • [Offene Posten] Parameter Zahlungsart in debitorenZahlungCreate und kreditorenZahlungCreate wird nicht ausgewertet - behoben

Funktionen (Release 16.0 unterstützt shakehands Kontor 16.0.1)

  • [Artikel] artikelModify zur Artikelbearbeitung - integriert
  • [Adressen, Artikel und Leistungen] Neuer Suchparameter matchcode in Adressefilter und  Artikelfilter
  • [Verkauf] Neuer Input-Parameter und neue Suchparameter
  • [EInkauf] Neue Suchparameter
  • [Buchungen] Neue Funktion buchungAddAttachment
  • [Debitoren und Kreditoren] Neuer Parameter Projekt_ID

Funktionen (Release 15.0 unterstützt shakehands Kontor 15.1.0, 15.2.0, 15.3.0)

  • [Filter] neue Optionen in Artikel, Offene Posten, Buchungen - integriert
  • [Artikel] neue Parameter GesamtRabattGesperrt, OnlineShopArtikel- integriert 
  • [Adressen] Bankdaten setzen, modifizieren - integriert

Release Notes

Systemanforderungen

Apple Macintosh

  • INTEL- oder ARM-basierter Mac
  • Bildschirm mit 1280 x 800 Pixel
  • Freier Festplattenspeicher > 1 GB
  • Apple macOS 10.14 (Mojave), macOS 10.15 (Catalina), macOS 11.x (Big Sur), macOS 12.x
  • 64-Bit Betriebsystem
  • Fonts Helvetica, Arial

Eigene Middleware, cubeSQL Server, shakehands Kontor

Microsoft Windows

  • (x86)-kompatibler Prozessor
  • Bildschirm mit 1280 x 800 Pixel
  • Freier Festplattenspeicher > 1 GB
  • Microsoft Windows 10, Windows 11
  • 64-Bit Betriebssystem
  • Font Arial

Eigene Middleware, cubeSQL Server, shakehands Kontor