Ja, es gibt eine Schnittstelle zu helloCash. Hier in diesem Beitrag erklären wir dir alles zur helloCash API. Informiere dich hier!
ACHTUNG: Seit 07.01.2022 ist die helloCash Schnittstelle (API) nur mehr ab dem Premium Modell verfügbar. Zusätzlich wird unsere Schnittstelle auf 60 Anfragen pro Minute limitiert, um einen verlässlichen Betrieb weiterhin zu ermöglichen. Wenn du dir nicht sicher bist, ob du die helloCash API nutzt oder wie du das Ratelimit prüfen kannst, wende dich an deinen zuständigen IT-Techniker. Hier findest du nun die wichtigsten Fragen zur API.
Was ist eine Schnittstelle (API)?
Eine API (Application Programming Interface) ist eine Programmierschnittstelle, welche es dir ermöglicht, zwei Softwaresysteme miteinander verbinden zu können. Entwickler können somit auf die Funktionen einer Anwendung zugreifen und diese in ein anderes System einbinden.
Hier zwei Beispiel anhand der helloCash API:
- Du nutzt helloCash, um Rechnungen zu erstellen und um deine Artikel sowie den Artikelbestand zu verwalten. Deine Artikel verkaufst du aber über deinen Onlineshop, der über einen anderen Anbieter läuft (z.B. woocommerce, Shopify, …). Damit sich der Warenbestand in der helloCash Kasse automatisch anpasst, sobald du einen Artikel über den Onlineshop verkaufst, kannst du den API Endpunkt change article stock verwenden.
- Nutzt du ein IT-Vorsystem (z. B. ein Buchhaltungssystem), kannst du auch mit unserer API das Vorsystem mit helloCash verbinden. Beispielsweise übergibt das Vorsystem mittels dem API Endpunkt create a new invoice Rechnungsdaten an die helloCash Kasse. Dort wird dann eine Rechnung erstellt.
Weitere helloCash API Endpunkte findest du in unserer API Dokumentation.
Wo ist die Schnittstellen Dokumentation zu finden?
Die Dokumentation zur helloCash Schnittstellen findest du unter:
https://hellocash.docs.apiary.io/#
Sämtliche Funktionen (Rechnung erstellen, Kassabucheinträge, Warenbestand, Artikel, …) sind darin beschrieben. Die API wird ständig weiterentwickelt und es kommen immer wieder neue Funktionen hinzu. Wir halten dich darüber aber immer auf dem Laufenden. Zurzeit gibt es nur jene Funktionen, welche in der technischen Dokumentation enthalten sind.
Mit Stichtag 07.01.2022 ist die Schnittstelle ab der Premium Kasse verfügbar. Damit du die API weiterhin verwenden kannst, musst du in das Premium (oder Gastro) Modell wechseln. In unserem FAQ Artikel erklären wir dir genau, wie das funktioniert. Bist du bereits im Premium (oder Gastro) Modell, kannst du diesen Schritt überspringen.
Wenn du dir nicht sicher bist, ob du die helloCash API verwendest, wende dich bitte an deinen zuständigen IT-Techniker.
Möchtest du die helloCash API vorab testen, kannst du das in unserer helloCash Demo Version machen. Bei Fragen dazu, kannst du dich gerne an unseren Support wenden.
Wie kann ich die helloCash Schnittstelle (API) verwenden?
Ab 30.11.2023 wird unsere API- Authentifizierungsmethode von Basic Authentication zu Bearer Token Authentication geändert. Bis dahin solltest du- oder der Programmierer deines Vertrauens- das neue API Token in deiner API-Anfrage einbinden.
Das funktioniert wie folgt:
- Navigiere zu Registrierkasse-Einstellungen-Allgemein-helloCash API
- Generiere ein API Token
- Füge das Token im Autorisierungs-Header deiner API-Anfragen hinzu.
Im Screenshot unten sind die Bereiche markiert, wo du das neue API-Token finden kannst:
API Endpunkte
Die API selbst ist unter folgendem Endpunkt erreichbar:
https://api.hellocash.business/api/v1
Die Details für die Einbindung bzw. korrekte Nutzung und Übermittlung der jeweils benötigten Parameter, als auch Beispiele, finden sich in unserer Schnittstellen-Dokumentation.
Es kann auch gegen einen Mock-Server getestet werden (siehe technische Dokumentation), dieser liefert nur statische Ergebnisse zurück.
Wird der Produktiv-Endpunkt angegeben, muss folgendes beachtet werden:
- Falls der Echt-Server verwendet wird, ist zu beachten, dass in der Premium- oder Gastro-Version echte Rechnungen und Daten erstellt werden. Zu Testzwecken sollte daher z.B. in der Rechnungserstellung folgendes Flag gesetzt werden: “invoice_testMode“ : true. Somit werden zwar echte Rechnungen erstellt, aber nur im Test-Modus. In der Kasse selbst kann der Test-Modus unter Registrierkasse > Einstellungen > Allgemein gestartet werden. Bitte kontaktiere uns hierzu unter info@hellocash.at
Wie kann ich das Ratelimit prüfen?
Unsere helloCash Schnittstelle ist auf 60 Anfragen pro Minute beschränkt. Dies ist eine gängige Maßnahme, um zukünftig auch weiterhin eine sichere und verlässliche Schnittstelle für dich anbieten zu können.
Bitte überprüfe in deiner Einbindung, ob du dieses Limit auch wirklich einhältst. Wenn du nicht weißt, wie du bei dieser Prüfung vorgehen musst, wende dich bitte an deinen IT-Techniker.
Benötigst du Hilfe?
Benötigst du bei der Einrichtung der API Hilfe, dann ziehe den IT-Techniker deines Vertrauens zurate. Dieser kann dich auch bei der Überprüfung des Ratelimits unterstützen.
Bei Fragen zu unserer Schnittstelle kannst du gerne unser Support-Team kontaktieren.
