Integration in Ihre Lösungen

Mit der Integration in Ihre Software ergeben sich für Ihre Anwender verschiedene Vorteile wie beispielsweise:

  •  Keine Installation / Konfiguration der ComputerApp auf Computer des Anwenders notwendig
  •  Problematik "Textcursor Positionierung in Eingabefeld" entfällt
  •  Ihre Software kann auch im Hintergrund oder minimiert auf Datenempfang reagieren
  •  Keine Eingabeverzögerungen beim Arbeiten über Remotedesktop, Fernwartungen, Citrix, etc.
  •  Optimale Integration in bestehende Prozesse
  •  Möglichkeit der vollintegrierten Digitalisierung der Papierrechnung
  •  Zusätzliche Kosten bei Defekt von Hand-Scanner entfällt
  •  Kompatibilität zu Ihrer Software für Kunde garantiert
  •  Support-Anfragen Ihrer Anwender wegen falsch konfigurierten Beleglesern entfallen


Vorgehen zur Integration

Die QR-Zahlteil App lässt sich mit wenig Aufwand in Ihre Projekte integrieren. Die API basiert auf WebSockets und kann so in allen gängigen Programmiersprachen angesprochen werden.

Eine Integration erfolgt am einfachsten in folgenden Schritten:

  1. Demo Projekt zur Erläuterung der API ansehen
  2. ApiKey generieren
  3. API mit erhaltenem ApiKey in eigener Lösung implementieren


Demo Projekt zur Erläuterung der API ansehen

Verwenden Sie das Demo Projekt als Einstieg. In diesem Html5 Beispiel ist die Integration der API ersichtlich. Die einzelnen Ereignisse und möglichen Parameter sind dort dokumentiert. Die Kommunikation erfolgt mittels JSON Objekten in folgenden Schritten:

  1. Verbindungsaufbau mittels connect mit QR-Zahlteil Server
  2. Meldungen des Servers zu verschiedenen Ereignissen behandeln wie
    • connected bei erfolgreicher Verbindung Ihres Programmes mit QR-Zahlteil Server
    • scanner_connected bei erfolgreicher Kopplung des Smartphones mit Ihrem Programm
    • scanned beim Lesen einer QR-Rechnung duch den Benutzer
    • scanner_disconnected bei einer Trennung der Verbindung zum Smartphone


ApiKey generieren

Erstellen Sie einen eingenen ApiKey, um die API von QR-Zahlteil anzusprechen. Bitte beachten Sie, dass der im Demo Projekt verwendete ApiKey temporär und eingeschränkt ist. Die Verwendung des Demo ApiKey in Ihrer Applikation führt zu einer verschlechterten Bedienbarkeit für Ihre Benutzer.

Erstellen Sie jetzt Ihren ApiKey, um einen optimalen Einsatz der Lösung für Ihre Benutzer sicherzustellen.


API mit erhaltenem ApiKey in eigener Lösung einsetzen

Verwenden Sie den generierten ApiKey beim Aufruf von connect als Parameterwert für apiKey.


Best Practices - Tipps zur Integration

Bei der Integration helfen folgende Tipps.

Behandeln Sie eine Schliessung der Verbindung zum QR-Zahlteil Server
Ein Unterbruch der Verbindung kann aus verschiedenen Gründen auftreten. Ihr Anwender könnte Internetprobleme haben oder der QR-Zahlteil Server hat nach Inaktivität die Verbindung geschlossen.

a) Geben Sie Ihren Anwendern die Möglichkeit, die Verbindung manuell wieder herzustellen.
b) Wenn Ihr Programm die Verbindung automatisch wiederherstellt, implementieren Sie eine zufällige Wartezeit für jeden Anwender. Sie verhindern damit, dass der QR-Zahlteil Server bei zu vielen Anfragen in kurzer Zeit Ihre Anwender zwecks DDoS Prävention vorübergehend blockiert.

Nutzen Sie bei connect den Parameter installationKey
Damit stellt Ihnen die QR-Zahlteil API eine anonyme Nutzungsstatistik wie in nachfolgendem Beispiel zur Verfügung. Ein installationKey identifiziert jeweils eine Kundeninstallation Ihrer Software. Als Wert kann beispielsweise ein Hash des Produkt-Schlüssels Ihres Kunden verwendet werden.