Menu

Kontor Link

Application-Programming-Interface (API)

shakehands Kontor Link ist das universale 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 Datenbank an einen eigenen Webshop, an ein eigenes CRM-Tool, an eigene Warenwirtschaftsysteme, oder an andere Datenbank an. Drittapplikationen tauschen darüber Daten aus. 

    Sie automatisieren zum Beispiel das Verarbeiten von Bestellungen, oder den automatischen Abgleich von Adressdaten oder der Offenen Posten oder sie exportieren die Lagerbestände an eine externe Logistikapplikationen für Dritte. Sie rechnen die Leistungen aus mobilen Apps 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 die Schnittstelle alle möglichen Daten automatisch ab und integrieren Sie andere Drittlö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ätzen. 

   shakehands Kontor Link verwendet zur Sicherung der Datenbankkonsistenz immer 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.

Hier 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 ein Beleg mit QR-Rechnung 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 synchronisieren um hier die Rechnung zu erstellen.

    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 zu integrieren.    

Lieferumfang

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

shakehands Kontor Link umfasst:

  • 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 zum Entwickeln

Folgende notwendige Voraussetzungen müssen erfüllt sein für das Programmieren der Schnittstelle und der Middleware. 

Sie brauchen:

  • eine aktive shakehands Kontor Lizenz
  • eine 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 Applikation und shakehands Kontor Link die gleiche Versionierung (Datenbankschema) aufweisen müssen und der cubeSQL Server für die Applikation-Version freigeben ist. 

    Sie brauchen eine eigene Entwicklerin oder einen Entwickler, der die Middleware programmiert, wenn Sie selber diese Voraussetzung nicht mitbringen. Oder Sie beauftragen eine Partnerin oder einen Partner mit dem 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. Beachten Sie, sie erhalten von ShakeHands Software Ltd keine fertige Kommunikationslösung. 

    Die konkrete Implementierung einer Schnittstelle zwischen den Applikationen bleibt Ihnen vorbehalten rsp. muss  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 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 einer gekauften Lizenz frei lizenzierbar.    

     shakehands Kontor Link ist kostenlos. Sie benötigen zum Einsatz der Software eine persönliche Lizenznummer. Dies für die Entwicklerversion und dann 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 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: eine Developer-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 einer Bestellung stellen wir einige Fragen zum 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. Eine Einführungsschulungen ist möglich. 

Entwicklen Sie die eigene shakehands App!


API kostenlose ErweiterungBestellen

Update Informationen

Funktionen (Release 21.0, unterstützt shakehands Kontor 21.0)

  • [Allgemein] DB/API Schema bleibt auf Version 101
  • [Allgemein] Änderungen zur Verbesserung der Stabilität
  • [Verkaufsbelege] Filteroption Schlussrechnung hinzugefügt 

Fehlerkorrekturen

  • [Adressen] Fehler bei Aktualisierung Addressnummer in adresseModify - korrigiert
  • [Artikel und Leistungen] Fehler Ausgabe Nachkommastellen Preise EK/VK -- beseitigt
  • [Debitoren] Fehler in debitorenZahlungCreate bei Benutzung OSS-Steuergebiet in Einnahme-Überschussrechnung - korrigiert 

Funktionen (Release 20.4, unterstützt shakehands Kontor 20.4)

  • [Allgemein] DB/API Schema bleibt auf Version 100
  • [Allgemein] Änderungen zur Verbesserung der Stabilität

Fehlerkorrekturen

  • [Adressen] Fehlende Erzeugung von Debi/Kredi-Konten bei Statusänderung - korrigiert
  • [Verkauf] Der Zahlungstext eines bestehenden Belegs ändert sich beim Drucken - behoben
  • [Einkauf]  Der Zahlungstext eines bestehenden Belegs ändert sich beim Drucken - behoben

Funktionen (Release 20.3, intern unterstützt shakehands Kontor 20.3)

Aktualisierungen/Verbesserungen/Änderungen

  • [Adressen] adresseSepaMandatPrintPDF, Unterstütztung DynaPDF
  • [Verkauf] verkaufbelegPrintPDF, Unterstütztung DynaPDF
  • [Einkauf] einkaufbelegPrintPDF, Unterstütztung DynaPDF

Fehlerkorrekturen

  • [Einkauf] einkaufbelegWeiterleitung, Positionsbezeichnungen lassen sich aktualisieren

Funktionen (Release 20.1 unterstützt shakehands Kontor 20.1)

  • [Allgemein] DB/API Schema bleibt auf Version 99
  • [Allgemein] Änderungen zur Verbesserung der Stabilität
  • [Einkauf] Neue Parameter um VorbelegBestellNr, VorbelegBestell_ID in Belegpositionen
  • [Debitoren] Unterstützung Parameter Text in DebitorenRechnungPositionAddItem beim Anlegen von Debitorenrechnungen mit mehreren Positionen
  • [Kreditoren] Unterstützung Parameter Text in KreditorenRechnungPositionAddItem beim Anlegen von Kreditorenechnungen mit mehreren Positionen
  • [Attachement] Filter um DatumVonParent, DatumBisParent erweitert.

Funktionen (Release 20.0 unterstützt shakehands Kontor 20.1)

  • [Allgemein] Änderung DB/API Schema auf Version 99
  • [Verkauf] Unterstützung Ansprechpartner in Verkaufsbelegen
  • [Einkauf] Unterstützung Ansprechpartner in Einkaufsbelegen
  • [Aktivität] Unterstützung Aktivität implementiert

Funktionen (Release 19.3 unterstützt shakehands Kontor 19.3.1)

  • [Client-/Server-Betrieb] Unterstützung für cubeSQL 5.9

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 (Monterey), macOS 13.x (Ventura), macOS (Sonoma)
  • 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, Microsoft Windows 11
  • 64-Bit Betriebssystem
  • Font Arial

Eigene Middleware, cubeSQL Server, shakehands Kontor