Il viesapi-cli.exe L'applicazione client consente il controllo rapido e automatico delle entità (appaltatori) da riga di comando (CLI/CMD) in termini di stato attuale nel sistema VIES. L'applicazione consente inoltre di salvare i dati scaricati in un file in 3 formati:

• JSON
• PROP (elenco delle proprietà nella forma chiave = valore)
• XML

L'applicazione è stata testata con successo nelle seguenti versioni di MS Windows: XP, 7, 10 e 11. L'ultima versione dell'applicazione è sempre disponibile per il download dal sito Scarica pagina.

La piena funzionalità dell'applicazione può essere verificata – senza la necessità di creare un account – utilizzando l'apposito API di prova

Per utilizzare l'add-in nell'API di produzione, è necessario creare un account sul sito viesapi.eu, acquistare un minimo del piano Business e generare una chiave API e un identificatore di chiave API.

Il processo di registrazione e creazione di un account, nonché la generazione di chiavi è stato descritto in Documentazione sito web.

Attivazione

Il programma eseguibile condiviso viesapi-cli.exe non richiede installazione e non deve essere eseguito con un account con privilegi di amministratore. Per eseguire il programma, selezionare il Command Prompt domanda dal Start menu o tipo cmd nel Search programs and files campo e premere Invio:

Dopo aver avviato la console, vai alla directory in cui è contenuto il file zip viesapi-cli.exe è stato scaricato e decompresso.

Avviando il programma senza specificare i parametri viene visualizzata la finestra della guida.

Configurazione

Lanciando il viesapi-cli.exe domanda senza specificare il API key ID e API key consente di interrogare l'ambiente di test (maggiori dettagli sul file Prova l'API VIES pagina).

Per connettersi all'ambiente di produzione, è necessario richiamare il viesapi-cli.exe applicazione con i parametri di autenticazione, che sono:

• keyid – il parametro deve contenere l'identificatore della chiave API (ID) generato sull'account sul sito viesapi.eu,
• key – il parametro deve contenere la chiave API (Key) generata sull'account sul sito viesapi.eu.

I dettagli sulla generazione dell'identificatore e della chiave sono descritti in Documentazione pagina. Di seguito è riportato un esempio di chiamata dell'applicazione con parametri di autenticazione (keyid e key):

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

Sintassi di chiamata

Sintassi della chiamata del viesapi-cli.exe programma:

viesapi-cli.exe <action> [options]

Azioni disponibili:

-help – descrizione dei parametri di chiamata del programma
-vies – stato attuale del sistema VIES
-account – stato del conto corrente
-data – ottenere i dati aziendali da VIES
-data-parsed – ottenere dati aziendali da VIES con dati analizzati
-batch-upload – carica un lotto di numeri di partita IVA e ottieni il token del lotto
-batch-download – controlla il risultato del batch e scarica i dati

Opzioni disponibili:

-keyid string – Identificatore chiave API
-key string – Chiave API
-euvat number – Numero di partita IVA UE con prefisso del paese
-token string – valore del token batch
-format type – tipo di formato di output (json, prop, xml), predefinito: json
-file-in path – percorso del file di input
-file-out path – percorso del file di output
-proxy url – Configurazione proxy HTTP (come URL http://user:password@hostname:port)

Esempi

ATTENZIONE! Gli esempi seguenti sono adattati ai dati raccolti nell'ambiente di test. Per eseguire i controlli sull'ambiente di produzione, aggiungere il –keyid e –key parametri con i valori appropriati per ciascuna query.

1. Controlla lo stato attuale del sistema VIES e visualizza il risultato come XML:

viesapi-cli.exe -vies -format xml

2. Controlla lo stato corrente dell'account e salva il risultato in un file JSON:

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

3. Scarica i dati aziendali da VIES e visualizza il risultato come PROP:

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

4. Scarica i dati analizzati dall'azienda da VIES e salva il risultato in un file JSON:

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

5. Carica un file batch (un numero per riga) e riceve un token batch per il controllo dei risultati:

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

6. Controlla lo stato corrente del batch e salva il risultato in un file JSON:

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