La viesapi-cli.exe L'application cliente permet de vérifier rapidement et automatiquement le statut actuel des entités (entrepreneurs) dans le système VIES, en ligne de commande (CLI/CMD). Elle permet également d'enregistrer les données téléchargées dans un fichier aux trois formats suivants :

• JSON
• PROP (liste de propriétés sous forme clé = valeur)
• XML

L'application a été testée avec succès dans les versions suivantes de MS Windows : XP, 7, 10 et 11. La dernière version de l'application est toujours disponible en téléchargement à partir du Télécharger page.

La fonctionnalité complète de l'application peut être vérifiée - sans avoir besoin de créer un compte - en utilisant le Tester l'API

Pour utiliser le complément dans l'API de production, vous devez créer un compte sur le site viesapi.eu, acheter au minimum le plan Business et générer une clé API et un identifiant de clé API.

Le processus d'enregistrement et de création d'un compte ainsi que la génération de clés ont été décrits sur le Documentation site Internet.

Activation

Le programme exécutable partagé viesapi-cli.exe ne nécessite pas d'installation et n'a pas besoin d'être exécuté sous un compte avec des privilèges d'administration. Pour exécuter le programme, sélectionnez le Command Prompt candidature de la Start menu ou type cmd dans le Search programs and files champ et appuyez sur Entrée :

Après avoir démarré la console, allez dans le répertoire où se trouve le fichier zip avec viesapi-cli.exe a été téléchargé et décompressé.

Le démarrage du programme sans spécifier de paramètres affiche la fenêtre d'aide.

Configuration

Lancer le viesapi-cli.exe demande sans préciser le API key ID et API key permet d'interroger l'environnement de test (plus de détails sur le Tester l'API VIES page).

Pour se connecter à l'environnement de production, il est nécessaire d'appeler le viesapi-cli.exe application avec les paramètres d'authentification, qui sont :

• keyid – le paramètre doit contenir l'identifiant (ID) de la clé API générée sur le compte sur le site viesapi.eu,
• key – le paramètre doit contenir la clé API (Key) générée sur le compte sur le site viesapi.eu.

Les détails sur la génération de l'identifiant et de la clé sont décrits sur le Documentation page. Ci-dessous un exemple d'appel de l'application avec des paramètres d'authentification (keyid et key):

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

Syntaxe d'appel

Syntaxe d'appel du viesapi-cli.exe programme:

viesapi-cli.exe <action> [options]

Actions disponibles :

-help – description des paramètres d'appel du programme
-vies – état actuel du système VIES
-account – état du compte courant
-data – obtenir les données de l’entreprise à partir de VIES
-data-parsed – obtenir les données de l’entreprise à partir de VIES avec des données analysées
-batch-upload – téléchargez un lot de numéros de TVA et obtenez un jeton de lot
-batch-download – vérifier le résultat du lot et télécharger les données

Options disponibles:

-keyid string – Identifiant de clé API
-key string - Clé API
-euvat number – Numéro d'identification à la TVA de l'UE avec le préfixe du pays
-token string – valeur du jeton de lot
-format type – type de format de sortie (json, prop, xml), par défaut : json
-file-in path – chemin du fichier d'entrée
-file-out path – chemin du fichier de sortie
-proxy url – Configuration du proxy HTTP (comme URL http://user:password@hostname:port)

Exemples

ATTENTION! Les exemples suivants sont adaptés aux données collectées dans l'environnement de test. Pour effectuer des vérifications sur l'environnement de production, ajoutez le –keyid et –key paramètres avec les valeurs appropriées à chaque requête.

1. Vérifie l'état actuel du système VIES et affiche le résultat au format XML :

viesapi-cli.exe -vies -format xml

2. Vérifie l'état actuel du compte et enregistre le résultat dans un fichier JSON :

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

3. Télécharge les données de l'entreprise à partir de VIES et affiche le résultat sous la forme PROP :

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

4. Télécharge les données analysées de l'entreprise à partir de VIES et enregistre le résultat dans un fichier JSON :

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

5. Télécharge un fichier batch (un numéro par ligne) et reçoit un jeton batch pour la vérification des résultats :

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

6. Vérifie l'état actuel du lot et enregistre le résultat dans un fichier JSON :

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