De viesapi-cli.exe De clientapplicatie maakt het mogelijk om entiteiten (contractanten) snel en automatisch te controleren op hun huidige status in het VIES-systeem vanaf de opdrachtregel (CLI/CMD). De applicatie biedt ook de mogelijkheid om de gedownloade gegevens op te slaan in een bestand in 3 formaten:

  • JSON
  • PROP (lijst met eigenschappen in de vorm van sleutel = waarde)
  • xml

De applicatie is succesvol getest in de volgende versies van MS Windows: XP, 7, 10 en 11. De nieuwste versie van de applicatie is altijd beschikbaar om te downloaden van de Downloaden bladzijde.

De volledige functionaliteit van de applicatie kan worden gecontroleerd - zonder de noodzaak om een account aan te maken - met behulp van de meegeleverde Test-API

Om de add-in in de productie-API te gebruiken, moet u een account aanmaken op de website viesapi.eu, minimaal het Business-abonnement kopen en een API-sleutel en API-sleutel-ID genereren.

Het proces van het registreren en opzetten van een account en het genereren van sleutels is beschreven op de Documentatie website.

activering

Het gedeelde uitvoerbare programma viesapi-cli.exe vereist geen installatie en hoeft niet te worden uitgevoerd onder een account met beheerdersrechten. Om het programma uit te voeren, selecteert u de Command Prompt aanvraag van de Start menu of type cmd in de Search programs and files veld en druk op Enter:

Ga na het opstarten van de console naar de map waar het zip-bestand zich bevindt viesapi-cli.exe is gedownload en uitgepakt.

Als u het programma start zonder parameters op te geven, wordt het helpvenster weergegeven.

Configuratie

Het lanceren van de viesapi-cli.exe toepassing zonder de API key ID en API key stelt u in staat om de testomgeving te bevragen (meer details op de VIES-API testen bladzijde).

Om verbinding te maken met de productieomgeving is het noodzakelijk om de viesapi-cli.exe toepassing met de authenticatieparameters, die zijn:

  • keyid – de parameter moet de API key identifier (ID) bevatten die is gegenereerd op het account op de website viesapi.eu,
  • key – de parameter moet de API-sleutel (sleutel) bevatten die is gegenereerd op het account op de website viesapi.eu.

Details over het genereren van de identifier en sleutel worden beschreven op de Documentatie bladzijde. Hieronder ziet u een voorbeeld van het aanroepen van de applicatie met authenticatieparameters (keyid en key):

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

Aanroepende syntaxis

Syntaxis van het aanroepen van de viesapi-cli.exe programma:

viesapi-cli.exe <action> [options]

Beschikbare acties:

-help - beschrijving van parameters voor het oproepen van programma's
-vies – huidige VIES-systeemstatus
-account – lopende rekeningstatus
-data – bedrijfsgegevens ophalen uit VIES
-data-parsed – bedrijfsgegevens ophalen uit VIES met geparseerde gegevens
-batch-upload – upload een batch btw-nummers en ontvang een batchtoken
-batch-download – controleer batchresultaat en downloadgegevens

Beschikbare opties:

-keyid string – API-sleutel-ID
-key string - API sleutel
-euvat number – EU-btw-nummer met landvoorvoegsel
-token string – batch-tokenwaarde
-format type – uitvoerformaattype (json, prop, xml), standaard: json
-file-in path – invoerbestandspad
-file-out path – uitvoerbestandspad
-proxy url – HTTP-proxyconfiguratie (als URL http://user:password@hostname:port)

Voorbeelden

AANDACHT! De volgende voorbeelden zijn aangepast aan de gegevens die in de testomgeving worden verzameld. Om controles uit te voeren op de productieomgeving, voegt u het –keyid en –key parameters met de juiste waarden voor elke query.

1. Controleert de huidige VIES-systeemstatus en geeft het resultaat weer als XML:

viesapi-cli.exe -vies -format xml

2. Controleert de huidige rekeningstatus en slaat het resultaat op in een JSON-bestand:

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

3. Downloadt bedrijfsgegevens van VIES en geeft het resultaat weer als PROP:

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

4. Downloadt de door het bedrijf geparseerde gegevens van VIES en slaat het resultaat op in een JSON-bestand:

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

5. Uploadt een batchbestand (één nummer per regel) en ontvangt een batchtoken voor resultaatcontrole:

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

6. Controleert de huidige batchstatus en slaat het resultaat op in een JSON-bestand:

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