POS Dealer API

Den Rollout per Skript steuern.

Die POS Dealer API automatisiert die Schritte vom unterschriebenen Rahmenvertrag bis zur produktiven Kasse. Ihr System lädt Betreiber ein, legt Standorte an und führt den Rollout-Plan aus, mit denselben Aufrufen in jedem Markt.

Die vier Funktionsgruppen

  • /posoperators – Betreiber einladen und verwalten
  • /…/outlets – Standorte je Betreiber anlegen und auflisten
  • /…/produce – Einen Rollout-Plan gegen Kontingente ausführen
  • /…/templates – Vollständige CashBoxen aus einer Vorlage erzeugenERGEBNIS

Vier Funktionsgruppen tragen den gesamten Rollout, vom Vertrag bis zur produktiven CashBox.

Endpunkte in vier Funktionsgruppen
8
Header bei jeder Anfrage
3
Rollout-Typen: Queue und Outlet
2
Vorlagen-Aufruf erzeugt eine vollständige CashBox
1

API-UMFANG

Acht Endpunkte, vier Aufgaben.

Jede Rollout-Aufgabe entspricht einem Aufruf. Die Referenz enthält die vollständigen Schemata.

EndpunktMethodeZweck
/api/posoperatorsPOSTEinen neuen PosOperator mit Firmendaten, Kennungen und Zugriffsrechten einladen
/api/posoperatorsGETDie mit Ihrem Konto verbundenen PosOperators auflisten
/api/posoperators/{id}/outletsGETDie Standorte eines Betreibers auflisten
/api/posoperators/{id}/outletsPOSTEinen neuen Standort für einen Betreiber anlegen
/api/posoperators/{id}/producePOSTEinen Rollout-Plan für ausgewählte Standorte oder Queues ausführen
/api/rollout-plansGETVerfügbare Rollout-Pläne mit ihren enthaltenen Produkten auflisten
/api/entitlementsGETKontingente mit Gesamt- und Restlaufzeit auflisten
/api/posoperators/{id}/templatesPOSTEine Vorlage ausführen, die die CashBox mit ihren Queues und Signaturerstellungseinheiten anlegt

DER ROLLOUT-ABLAUF

Vom Vertrag zur laufenden Kasse in vier Aufrufen.

Jeder Schritt ist ein Endpunkt. Wiederholen Sie die Abfolge, und hundert Standorte sind am selben Nachmittag ausgerollt.

  1. Betreiber einladen

    Firmendaten, Steuerkennungen und Kontaktperson senden. Zugriffsrechte festlegen: full, read oder readwrite.
  2. Standorte anlegen

    Jeden Standort mit Standortnummer, Adresse und Kontakt registrieren.
  3. Rollout-Plan ausführen

    Produkte gegen Ihre Kontingente für die ausgewählten Standorte oder Queues produzieren.
  4. Vorlage ausführen

    Ein Aufruf erzeugt die CashBox mit ihren Queues und Signaturerstellungseinheiten.

Kontingente kommen zuerst: Erwerben Sie sie im Voraus, zum Beispiel über einen Rahmenvertrag, und buchen Sie sie dann pro Rollout ab. GET /api/entitlements zeigt Gesamt- und Restlaufzeit, damit Ihr System den Bestand vor jedem Batch kennt.

VORLAGEN

Eine Vorlage. Eine vollständige CashBox.

Das Vorlagenschema definiert die gesamte Konfiguration: die CashBox, ihre Queues und die Signaturerstellungseinheiten. Marktspezifische Initialisierungsblöcke konfigurieren jedes Land innerhalb derselben Struktur.

template schema, trimmed
"ftCashBoxId": "guid",
"ftSignaturCreationDevices": [ ... ],
"ftQueues": [{
  "configuration": {
    "init_ftQueueAT": [ ... ],
    "init_ftQueueDE": [ ... ],
    "init_ftQueueFR": [ ... ],
    "init_ftQueueIT": [ ... ]
  }
}]
Wiederholbar
Dieselbe Vorlage rollt identische, vorab freigegebene Konfigurationen an allen Standorten aus. Keine von Hand gebauten CashBoxen, keine Abweichungen.
Pro Markt
Initialisierungsblöcke pro Land konfigurieren Queue und Signaturerstellungseinheit in einer Struktur.
Skriptfähig
Ihr Provisioning-System ruft den Endpunkt pro Standort auf. Die Vor-Ort-Zeit pro Standort sinkt von Stunden auf Minuten.

Ein Standort oder hundert. Das Skript bleibt gleich.

ZUGRIFF

Drei Header, klare Berechtigungen.

Jede Anfrage trägt dieselben drei Header. Die Zugriffsrechte der Betreiber (full, read oder readwrite) begrenzen, worauf jede Verbindung zugreifen darf.

  1. accountid

    Kennzeichnet Ihr POS-Dealer-Konto.
  2. accesstoken

    Authentifiziert die Anfrage.
  3. market

    Wählt den Zielmarkt für den Aufruf.

FAQ

Bevor Sie den Rollout skripten.

Kurze Antworten, die Schemata stehen in der Referenz.

Für wen ist diese API?

Für POS Dealer und Plattformen, die viele Betreiber und Standorte verwalten. Ihr Backoffice- oder Provisioning-System ruft die API auf, statt dass ein Techniker sich durch das Portal klickt.

Woher kommen die Kontingente?

Erwerben Sie Kontingente im Voraus, zum Beispiel über einen Rahmenvertrag, und buchen Sie sie dann pro Rollout ab. Der Endpunkt für Kontingente zeigt Gesamt- und Restlaufzeit.

Was enthält ein Rollout-Plan?

Eine Kennung, einen Rollout-Typ (Queue oder Outlet) und die enthaltenen Produkte. Führen Sie einen Plan gegen ausgewählte Standort- oder Queue-Kennungen aus.

Was erzeugt eine Vorlage?

Eine konfigurierte CashBox mit ihren Queues und Signaturerstellungseinheiten, einschließlich marktspezifischer Initialisierung. Ein Aufruf pro Standort.

Was steuern die Zugriffsrechte der Betreiber?

Jeder eingeladene PosOperator hat eine Zugriffsstufe: full, read oder readwrite. Legen Sie die Stufe bei der Einladung fest.

Woher stammen die Zugangsdaten?

Ihr POS-Dealer-Konto im fiskaltrust.Portal stellt accountid und accesstoken aus. Senden Sie beide zusammen mit dem Header market bei jeder Anfrage. Die API listet außerdem die Queues eines PosOperators auf und liefert Auftragsdetails pro Auftragsnummer; die genauen Pfade stehen in der Referenz.

Skripten Sie Ihren nächsten Rollout.

Lesen Sie die Referenz, binden Sie die vier Aufrufe in Ihr Provisioning-System ein und rollen Sie die nächsten hundert Standorte von Ihrem Schreibtisch aus.

Sie sprechen mit echten Menschen