Die viesapi-cli.exe Die Client-Anwendung ermöglicht eine schnelle und automatische Überprüfung von Entitäten (Auftragnehmern) auf Befehlszeilenebene (CLI / CMD) hinsichtlich ihres aktuellen Status im VIES-System. Die Anwendung ermöglicht es Ihnen außerdem, die heruntergeladenen Daten in einer Datei in drei Formaten zu speichern:

• JSON
• PROP (Liste der Eigenschaften in Form von Schlüssel = Wert)
• XML

Die Anwendung wurde erfolgreich in den folgenden Versionen von MS Windows getestet: XP, 7, 10 und 11. Die neueste Version der Anwendung steht immer zum Download bereit von der Download Seite.

Die volle Funktionalität der Anwendung kann – ohne die Notwendigkeit, ein Konto anzulegen – mit dem bereitgestellten überprüft werden API testen

Um das Add-in in der Produktions-API zu verwenden, müssen Sie ein Konto auf der Website viesapi.eu einrichten, mindestens den Business-Plan erwerben und einen API-Schlüssel und eine API-Schlüsselkennung generieren.

Der Prozess der Registrierung und Einrichtung eines Kontos sowie der Generierung von Schlüsseln wurde auf der beschrieben Dokumentation Webseite.

Aktivierung

Das freigegebene ausführbare Programm viesapi-cli.exe erfordert keine Installation und muss nicht unter einem Konto mit Administratorrechten ausgeführt werden. Um das Programm auszuführen, wählen Sie die Command Prompt Bewerbung von der Start Menü oder Typ cmd im Search programs and files Feld und drücken Sie die Eingabetaste:

Wechseln Sie nach dem Start der Konsole in das Verzeichnis, in dem sich die ZIP-Datei befindet viesapi-cli.exe wurde heruntergeladen und entpackt.

Wenn Sie das Programm starten, ohne Parameter anzugeben, wird das Hilfefenster angezeigt.

Aufbau

Starten der viesapi-cli.exe Anwendung ohne Angabe der API key ID und API key ermöglicht die Abfrage der Testumgebung (mehr Details auf der Testen Sie die VIES-API Seite).

Um eine Verbindung zur Produktionsumgebung herzustellen, ist es notwendig, die aufzurufen viesapi-cli.exe Anwendung mit den Authentifizierungsparametern, die sind:

• keyid – der Parameter sollte die API-Schlüsselkennung (ID) enthalten, die auf dem Konto auf der Website viesapi.eu generiert wurde,
• key – Der Parameter sollte den API-Schlüssel (Key) enthalten, der auf dem Konto auf der Website viesapi.eu generiert wurde.

Details zur Generierung von Kennung und Schlüssel sind auf der beschrieben Dokumentation Seite. Nachfolgend finden Sie ein Beispiel für den Aufruf der Anwendung mit Authentifizierungsparametern (keyid und key):

viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml

Aufrufsyntax

Syntax zum Aufrufen der viesapi-cli.exe Programm:

viesapi-cli.exe <action> [options]

Verfügbare Aktionen:

-help – Beschreibung der Programmaufrufparameter
-vies – aktueller Status des VIES-Systems
-account – aktueller Kontostand
-data – Unternehmensdaten aus VIES abrufen
-data-parsed – Unternehmensdaten aus VIES mit analysierten Daten abrufen
-batch-upload – Stapel von Umsatzsteuer-Identifikationsnummern hochladen und Stapel-Token erhalten
-batch-download – Batch-Ergebnis prüfen und Daten herunterladen

Verfügbare Optionen:

-keyid string – API-Schlüsselkennung
-key string - API-Schlüssel
-euvat number – EU-Umsatzsteuer-Identifikationsnummer mit Länderpräfix
-token string – Batch-Token-Wert
-format type – Ausgabeformattyp (json, prop, xml), Standard: json
-file-in path – Eingabedateipfad
-file-out path – Ausgabedateipfad
-proxy url – HTTP-Proxy-Konfiguration (als URL http://user:password@hostname:port)

Beispiele

AUFMERKSAMKEIT! Die folgenden Beispiele sind an die in der Testumgebung gesammelten Daten angepasst. Um Überprüfungen in der Produktionsumgebung durchzuführen, fügen Sie die –keyid und –key Parameter mit den entsprechenden Werten für jede Abfrage.

1. Überprüft den aktuellen VIES-Systemstatus und zeigt das Ergebnis als XML an:

viesapi-cli.exe -vies -format xml

2. Überprüft den aktuellen Kontostatus und speichert das Ergebnis in einer JSON-Datei:

viesapi-cli.exe -account -file-out result.json.

3. Lädt Unternehmensdaten aus VIES herunter und zeigt das Ergebnis als PROP an:

viesapi-cli.exe -data -euvat PL5213003700 -format prop

4. Lädt die vom Unternehmen analysierten Daten von VIES herunter und speichert das Ergebnis in einer JSON-Datei:

viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json

5. Lädt eine Batchdatei hoch (eine Zahl pro Zeile) und erhält ein Batch-Token zur Ergebnisprüfung:

viesapi-cli.exe -batch-upload -file-in numbers.csv

6. Überprüft den aktuellen Batch-Status und speichert das Ergebnis in einer JSON-Datei:

viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json