Service

Übersicht

Der fiskaly Service ist eine erstellte Version von fiskaly Client, der leicht in bestimmten Programmier-/Skriptsprachen verwendet werden kann, in denen es schwierig ist, unsere Client-Bibliothek einzubetten.

Herunterladen

Es wird als ausführbare Datei für verschiedene Betriebssysteme und Architekturen auf unserer Download-Seite ausgeliefert.

Starten

Windows

./com.fiskaly.service-windows-amd64-v1.1.600.exe

Linux

./com.fiskaly.service-linux-amd64-v1.1.600

Verwendung

Der fiskaly Service startet den HTTP-Server standardmäßig an Port 8080. Der Port kann durch Ändern der Systemvariablen FISKALY_LISTEN_ADDRESS geändert werden.

Der JSON-RPC Endpunkt ist /invoke, und alle definierten Methoden können durch Senden POST-Anfragen mit den richtigen Parametern aufgerufen werden.

Methoden

Eine ausführliche Beschreibung der verfügbaren JSON-RPC-Methoden finden Sie auf unserer Client-Bibliothek Seite.

Beispiele

Neuen Kontext erzeugen

Anfrage

curl --header "Content-Type: application/json" \
--request POST \
--data '{
"jsonrpc": "2.0",
"method": "create-context",
"params": {
"api_key": "'"$API_KEY"'",
"api_secret": "'"$API_SECRET"'",
"base_url": "https://kassensichv.io/api/v1/"
},
"id": 1
}' \
http://localhost:8080/invoke

Konfiguration

Anfrage

curl --header "Content-Type: application/json" \
--request POST \
--data '{
"jsonrpc": "2.0",
"method": "config",
"params": {
"config": {
"debug_level": 2,
"debug_file": "/var/log/fiskaly.log",
"client_timeout": 5000,
"smaers_timeout": 2000
},
"context": "'"$CONTEXT"'"
},
"id": 2
}' \
http://localhost:8080/invoke

Version

Anfrage

curl --header "Content-Type: application/json" \
--request POST \
--data '{
"jsonrpc": "2.0",
"method": "version",
"params": {},
"id": 3
}' \
http://localhost:8080/invoke

API Anfrage

Anfrage

curl --header "Content-Type: application/json" \
--request POST \
--data '{
"jsonrpc": "2.0",
"method": "request",
"params": {
"request": {
"method": "PUT",
"path": "/tss/ecb75169-680f-48d1-93b2-52cc10abb9ff/tx/9cbe6566-e24c-42ac-97fe-6a0112fb3c63",
"query": { "last_revision": "0" },
"headers": { "Content-Type": "application/json" },
"body": "eyJzdGF0ZSI6ICJBQ1RJVkUiLCJjbGllbnRfaWQiOiAiYTYyNzgwYjAtMTFiYi00MThhLTk3MzYtZjQ3Y2E5NzVlNTE1In0="
},
"context": "'"$CONTEXT"'"
},
"id": 4
}' \
http://localhost:8080/invoke

Fehler

The fiskaly Service will return errors as defined in the JSON-RPC 2.0 specification. For detailed information on errors visit client library errors

Der fiskaly Service gibt Fehler zurück, wie in der JSON-RPC 2.0-Spezifikation definiert. Ausführliche Informationen zu Fehlern finden Sie unter Fehler in der Clientbibliothek.

Debug Modus

Zur Unterstützung der Fehlerbehebung enthält der fiskaly-Service einen Debug-Modus. Wenn er aktiviert ist, werden Informationen mit variabler Granularität in eine Protokolldatei geschrieben. Die Ausführlichkeit wird durch das debug_level-Feld in der Konfiguration gesteuert. Gültige Debug-Level sind -1 (keine Ausgabe), 1 (nur Fehler), 2 (Fehler+Warnungen) und 3 (Fehler+Warnungen+Info). Die Ausgabedatei kann auch über die Methode config gesetzt werden. Die Voreinstellung ist /tmp/fiskaly.log.

SDK

Um die Implementierung von fiskaly Service zu vereinfachen, haben wir Open-Source-SDKs für viele Programmiersprachen wie PHP und Node.js entwickelt.

Die SDKs bieten Wrapper-Funktionen für unseren Service und Sie werden mit jeder Version des Clients aktualisiert.

Eine detaillierte Beschreibung der SDKs finden Sie auf unserer Download-Seite.

Last updated on