fiskaly Dashboard und Management API.
Mit dem fiskaly Dashboard haben Sie Einsicht über Ihre bei fiskaly gebuchten Produkte. Über das Dashboard können Sie Organisationen und deren Nutzer anlegen und verwalten, einsehen, welche Transaktionen gestartet werden sowie welche Clients und technischen Sicherheitseinrichtungen (TSE) angelegt wurden. Es visualisiert Ihre Daten und Sie sehen mit einem Blick, was im fiskaly System passiert.
Kostenlose Anmeldung beim fiskaly Dashboard
Um das fiskaly Dashboard verwenden zu können, benötigen Sie einen eigenen Account. Diesen können Sie kostenlos anlegen. Alle Firmen, die Sie im Test anlegen, können nach Vertragsabschluss auch in den Live Modus geschalten werden.
Info: Beim ersten Anmelden muss eine Hauptorganisation erstellt werden. Danach haben Sie die Möglichkeit Ihre Haupt- und verwalteten Organisationen über das Dashboard oder über die Management API anzulegen.
fiskaly Dashboard Handbuch
Das ausführliche Handbuch zum Dashboard gibt es auf der fiskaly Entwickler Website.
Management API
Über die Management API können Sie auch alle Funktionen des Dashboards programmatisch lösen. Lediglich die erste Hauptorganisation muss über das Dashboard angelegt werden. Die detaillierte Dokumentation der Schnittstellen-Funktionen mit ihren Parametern finden sie auf der fiskaly Entwickler Website. In der Management API werden die Begriffe Organization für Hauptorganisation und Managed Organization für verwaltete Organisation verwendet.
Organisationen und Benutzerrechte
Im fiskaly System wird zwischen Hauptorganisationen und verwaltete Organisationen unterschieden. Worin der Unterschied liegt und welche Auswirkungen das auf die Benutzerrechte hat, wird im Folgenden beschrieben. Auf der fiskaly Entwickler Website sind alle Informationen zu den Organisationen zu finden oder im Dashboard Benutzerhandbuch.
Was ist eine Hauptorganisation?
Eine Hauptorganisation ist eine maßgebliche Einheit im fiskaly System. Sie bildet in der Regel eine Holding, Geschäfts- oder Zweigstelle ab. Hauptorganisationen können kostenlos über das Dashboard angelegt werden. An sie können verwaltete Organisationen (im fiskaly System: managed organizations) angehängt werden. Verwaltete Organisationen können auch über die Hauptorganisation verwaltet werden. Im Organisationsmanagement können weitere Organisationen erstellt, Informationen eingesehen, zum Live Modus geschalten, ein Organisationslogo hinterlegt, User organisiert, API Keys für die Hauptorganisation erstellt und API Keys für die verwalteten Organisationen erzeugt werden.
Wichtig: eine Hauptorganisation kann keine verwaltete Organisation einer weiteren Hauptorganisation sein.
Benutzerrechte in der Hauptorganisation
Nutzer der Hauptorganisation, sowie Personen, die in die Hauptorganisation eingeladen werden, haben Zugriff auf alle Informationen, die im Dashboard der der Hauptorganisation angezeigt werden sowie zu den Informationen der anhängenden verwalteten Organisation(en) dieser Haupt- organisation. D.h. Übersicht Dashboard, TSE-Nummer(n), Client(s), Transaktionen, Exporte, Integrationen etc. werden den Nutzern angezeigt.
Was ist eine verwaltete Organisation?
Die verwaltete Organisation ist von der ihr übergeordneten Hauptorganisation abhängig und kann niemals alleine stehen. Sie muss immer einer Hauptorganisation untergeordnet sein. Verwaltete Organisationen werden mit dem Badge “managed” versehen. Sie können ebenfalls über das Dashboard angelegt werden.
Benutzerrechte in der verwalteten Organisation
Nutzer, die für die verwaltete Organisation freigeschalten sind, haben ausschließlich Zugriff auf die Informationen der jeweiligen verwalteten Organisation. Die Nutzer haben keinen Einblick in die Informationen der übergeordneten Hauptorganisation. Innerhalb der verwalteten Organisation haben Nutzer Zugriff auf das Dashboard und alle dort hinterlegten Informationen.
Wie erstelle ich eine verwaltete Organisation (managed organization)
Im Dashboard im Menüpunkt Einstellungen > Organisationsverwaltung auf den Button Neue Organisation erstellen klicken und das Kästchen Verwaltete Organisation erstellen auswählen. Anschließend angeben, unter welcher Hauptorganisation diese verwaltete Organisation angelegt werden soll.
Unter diesem Link finden Sie wie eine verwaltete Organisation über die Management API erstellt wird.
Dabei darauf achten, dass der Button ManagedOrganization ausgewählt ist.
Unterschied einer Haupt- von einer verwalteten Organisation
Im fiskaly System wird zwischen Hauptorganisationen und verwalteten Oganisationen unterschieden. Verwaltete Organisationen sind von der Hauptorganisation abhängig. Sie können selbst keine weiteren verwalteten Organisationen beinhalten. Ebenso kann eine Hauptorganisation keine verwaltete Organisation einer weiteren Hauptorganisation sein. Wichtig zu wissen ist, dass sich die Benutzerrechte von Haupt- und verwalteter Organisation unterscheiden.
Unterschied Benutzerrechte in Haupt- und verwalteter Organisation
Nutzer von Haupt- oder verwalteten Organisationen haben Zugriff auf die im Dashboard angezeigten Informationen der jeweiligen Organisation. Die Benutzerrechte innerhalb der Haupt- und der verwalteten Organisation unterscheiden sich darin, dass Nutzer der Hauptorganisation auch Zugriff zu den Informationen der jeweilige verknüpften verwalteten Organisationen haben. Nutzer der verwalteten Organisationen haben jedoch keinen Zugriff auf die Informationen der übergeordneten Hauptorganisation.
API Keys
Auf Organisationsebene muss mindestens ein API Key angelegt werden.
Über das Dashboard im Menüpunkt Entwickler > API Schlüssel auf den Button API Schlüssel erstellen klicken und einen Namen für den neuen API Schlüssel wählen. Anschließend Erstellen auswählen.
Achtung: das API Secret wird nur unmittelbar nach der Erstellung eines neuen API Schlüssels angezeigt!
API Keys können auch über die Management API erzeugt werden.
Mit dem dem API Key der Hauptorganisation können die verwalteten Organisationen verwaltet werden. Für jede verwaltete Organisation muss ein eigener API Key erzeugt werden, um eine TSE für diese zu erstellen und die weiteren Funktionalitäten der fiskaly SIGN API zu verwenden. API Keys für Hauptorganisationen müssen über das Dashboard oder die Management API erzeugt werden. Für verwaltete Organisationen können API Keys automatisiert erzeugt werden.
Ein API Key ist an eine Organisation sowie an den gewählten Modus (Test/Live) gebunden. Das bedeutet, dass jeder API Key auch nur für die eigene Organisation verwendet werden kann. Ausnahme: API Keys einer Hauptorganisation können die jeweils dazugehörenden verwalteten Organisationen verwendet werden.
Wurde der API Key im Test Modus erstellt, können mit diesem nur(!) Entitäten zu Testzwecken erzeugt werden. Mit einem im Live Modus erstellten Schlüssel, können somit auch nur(!) Live Entitäten produziert werden. Dh. in einer Live geschaltenen Organisation können mit dem Live API Key weitere verwaltete Organisationen erzeugt werden, so muss nicht jede verwaltete Organisation einzeln in den Live Modus geschalten werden.
Auf der fiskaly Entwickler Seite sind alle Informationen zu den API Keys hier zu finden.
Verrechnungsoptionen
Es gibt zwei Möglichkeiten die Verrechnung zu steuern:
Bill_to_Organization
Mit der Option Bill_to_Organization wird die Rechnung an die Hauptorganisation gestellt und kann auch über das Dashboard eingesehen werden.
Withhold Billing
Bei der Option Withhold Billing wird die Rechnung nicht an diese verwaltete Organisation gestellt und kann auch nicht über das Dashboard eingesehen werden. So kann die fiskaly TSE beispielsweise als ein Bestandteil eines Kassenpackets verkauft werden, ohne dass bei Ihrem Kunden der Preis der fiskaly TSE aufscheint.
Auf der fiskaly Entwickler Seite sind alle Informationen zur Verrechnung hier zu finden.
Organisationsstruktur
Kassenhersteller bietet fiskaly Cloud TSE in seinem Portfolio an
Ein Kassenhersteller verwendet für seine Kassensoftware die fiskaly Cloud TSE. Er bietet drei Lösungen seinen Kunden an. Typischerweise ist Punkt 1. Best Practice bei großen Kassenanbietern. Punkt 2. und 3. sind für komplexere Modelle konzipiert.
Kontaktieren Sie hierfür unser Sales Team: sales@fiskaly.com.
1. Einzelkunden – Best Practice Unter der Hauptorganisation des Kassenherstellers werden Einzelkunden als verwaltete Organisationen angelegt und verwaltet. Über die Hauptorganisation wird der jeweilige API Key der verwalteten Organisation erstellt. Die Verrechnungsoption wurde auf Withhold Billing gesetzt, da der Preis der fiskaly Cloud TSE in der Gesamtrechnung des Kassenherstellers an den Kunden beinhaltet ist.
2. Enterprise Kunden Der Kassenhersteller legt die Holding des Enterprise Kunden als Hauptorganisation an. Die Filialen des Enterprise Kunden werden als verwaltete Organisationen angelegt. Die Hauptorganisation des Enterprise Kunden wird mit dem API Key der Hauptorganisation des Kassenherstellers erzeugt. Es ist dem Kassenhersteller überlassen, ob der Enterprise Kunde seine Organisationen selbst verwaltet oder durch den Kassenanbieter verwaltet wird. Die Billing Optionen sind bei den Organisationen des Enterprise Kunden auf Withhold Billing gesetzt.
3. White Label Partner Der Kassenhersteller legt die Firma des White Label Partners als Hauptorganisation an. Die Kunden des White Label Partners werden als verwaltete Organisationen angelegt. Die Hauptorganisation des White Label Partner wird mit dem API Key der Hauptorganisation des Kassenherstellers erzeugt. Der White Label Partner verwaltet seine Kunden (verwaltete Organisationen) selbst. Die Billing Optionen sind bei den Organisationen der Kunden des White Label Partner auf Withhold Billing gesetzt.
Für andere Modelle oder Sonderfälle setzen Sie sich mit unserem Sales Team in Verbindung: sales@fiskaly.com.
Download
Hier steht der Artikel 'fiskaly Dashboard und Management API als PDF zum Download' zur Verfügung. 