Incert bietet mit der incert Public-API eine JSON/REST-API zur Anbindung durch externe Schnittstellenpartner (bspw. Kassensystem oder Booking Engine). Die API bietet unterschiedliche Funktionen, beispielsweise für die Einlösung von Gutscheinen oder die Beladung von vorgedruckten Karten. 

Bei Interesse, wenden Sie sich bitte an beratung@incert.at 

Dokumentation

• Eine Dokumentation (Prozessleitfaden & Swagger-Doku) kann nach einer initialen Abstimmung übermittelt werden.
• Vor Inbetriebnahme ist eine Abnahme mit incert erforderlich.

Anwendungsfälle & Systeme

Hier werden Anforderungen im Allgemeinen beschrieben und ein Überblick über die Kommunikation der Schnittstelle gegeben. Abhängig vom anzubindenden System (Kasse, Booking Engine, etc.) stellen wir detailliertere Umsetzungsanforderungen und -Empfehlungen auf Anfrage zur Verfügung.

Statusabfrage und Einlösung 

Allgemeine Anforderungen

• Der Status-Code des Gutscheins bestimmt die Einlösbarkeit (nur Status 1 bedeutet "einlösbar"). Für alle weiteren Status (Liste siehe Dokumentation) sollten sprechende Fehlermeldungen angezeigt werden.
• Gültigkeitsdatum, Zahlungsdatum, Gutscheintyp, etc. werden nur zu Informationszwecken übergeben. Darauf aufbauend soll keine Regel für die Einlösbarkeit implementiert werden. Die Einlösbarkeit wird von incert (gemäß Einstellungen des Kunden) über den Status gesteuert.
• Ein Beleg soll mit einem oder mehreren Gutscheinen komplett beglichen werden können oder auch aus einer Mischform von Gutschein und anderer Zahlungsart (z.B. Restzahlung mittels Kreditkarte, wenn Gutscheinwert nicht ausreicht) beglichen werden können. Die Einlösung(en) soll(en) dabei erst zum Zeitpunkt des Rechnungs- bzw. Buchungsabschlusses übertragen werden.
• Eine Gutscheineinlösung wird wie eine Zahlungsart behandelt und soll entsprechend die USt. der damit bezahlten Artikel nicht vermindern.
• Wird ein Beleg an der Kasse bzw. eine mit Gutschein bezahlte Buchung in der Booking-Engine storniert, müssen auch die zur Begleichung verwendeten Gutscheineinlösungen automatisiert zurückgenommen werden.
• API-Credentials sollen pro Betrieb (Hotel, Filiale, Geschäftsstelle, Standort …) hinterlegt werden können, zusätzlich soll eine eindeutige Kennung der einzelnen Workstation (z.B. Kassen-ID) übergeben werden.
• Sponsoring-Gutscheine können mit oder ohne Wert im System geführt werden. Bei Kassen sollten daher auch Gutscheine mit 0 EUR Wert einlösbar sein. Die Prüfung des Gegenwerts erfolgt durch den Mitarbeiter – in der Oberfläche kann dies beispielsweise durch Eingabe des Wertes, der von der Rechnung abgezogen wird, realisiert werden. An Incert muss in diesem Fall bei Einlösung dennoch immer 0€ übergeben werden.
  Bei Online-Einlösung oder an Self-Service-Automaten ist eine Einlösung mit 0 EUR Wert nicht erlaubt und muss unterbunden werden.

Abläufe

Die Tabelle zeigt eine reduzierte Übersicht über Request und Response. Die vollständigen Parameter entnehmen Sie unserer Swagger-Dokumentation.

Kartenbeladung

Allgemeine Anforderungen

• Wertkarten sind ein bestimmter Typ von Gutschein, der es erlaubt, einen Wert aufzubuchen
• Werkarten können mit einem beliebigen (an der Kasse einzugebenden) Betrag aufgeladen werden. Ober- und Untergrenzen können in incert definiert werden.
• Wertkarten sind dabei als Artikel handzuhaben, die mit den an der Kasse vorhandenen Zahlungsmöglichkeiten ausgecheckt werden können.
• Wertkarten können über das Kassensystem je nach Einstellung in incert auch mehrfach beladen werden.
• Wird ein Werkartenkauf auf der Kasse rückabgewickelt (Kauf wird storniert), muss das Storno der Kartenaufladung automatisiert an incert gesendet werden.

Abläufe

Die Tabelle zeigt eine reduzierte Übersicht über Request und Response. Die vollständigen Parameter entnehmen Sie unserer Swagger-Dokumentation.