los viesapi-cli.exe La aplicación cliente permite la comprobación rápida y automática de entidades (contratistas) desde la línea de comandos (CLI/CMD) en cuanto a su estado actual en el sistema VIES. La aplicación también permite guardar los datos descargados en un archivo en tres formatos:
- JSON
- PROP (lista de propiedades en forma de clave = valor)
- XML
La aplicación ha sido probada con éxito en las siguientes versiones de MS Windows: XP, 7, 10 y 11. La última versión de la aplicación siempre está disponible para descargar desde Descargar página.
La funcionalidad completa de la aplicación se puede verificar, sin necesidad de crear una cuenta, utilizando el API de prueba
Para usar el complemento en la API de producción, debe configurar una cuenta en el sitio web viesapi.eu, comprar un mínimo del plan Business y generar una clave de API y un identificador de clave de API.
El proceso de registro y configuración de una cuenta, así como la generación de claves, se ha descrito en el Documentación sitio web.
Activación
El programa ejecutable compartido viesapi-cli.exe no requiere instalación y no tiene que ejecutarse con una cuenta con privilegios administrativos. Para ejecutar el programa, seleccione el Command Prompt aplicación de la Start menú o tipo cmd en el Search programs and files campo y presione Entrar:
Después de iniciar la consola, vaya al directorio donde se encuentra el archivo zip con viesapi-cli.exe fue descargado y descomprimido.
Iniciar el programa sin especificar parámetros muestra la ventana de ayuda.
Configuración
Lanzando el viesapi-cli.exe aplicación sin especificar el API key ID y API key le permite consultar el entorno de prueba (más detalles en el Pruebe la API de VIES página).
Para conectarse al entorno de producción, es necesario llamar al viesapi-cli.exe aplicación con los parámetros de autenticación, que son:
keyid– el parámetro debe contener el identificador de clave API (ID) generado en la cuenta en el sitio web viesapi.eu,key– el parámetro debe contener la clave API (Clave) generada en la cuenta en el sitio web viesapi.eu.
Los detalles sobre la generación del identificador y la clave se describen en la Documentación página. A continuación se muestra un ejemplo de cómo llamar a la aplicación con parámetros de autenticación. (keyid y key):
viesapi-cli.exe -keyid XXXXXXXXXXXX -key YYYYYYYYYYYY -vies -format xml
Sintaxis de llamada
Sintaxis de llamada al viesapi-cli.exe programa:
viesapi-cli.exe <action>
Acciones disponibles:
-help – descripción de los parámetros de llamada del programa
-vies – estado actual del sistema VIES
-account – estado de la cuenta corriente
-data – obtener datos de la empresa de VIES
-data-parsed – obtener datos de la empresa de VIES con datos analizados
-batch-upload – cargar lote de números de IVA y obtener el token del lote
-batch-download – comprobar el resultado del lote y descargar datos
Opciones disponibles:
-keyid string – Identificador de clave API
-key string - Clave API
-euvat number – Número de identificación de IVA de la UE con prefijo de país
-token string – valor del token por lote
-format type – tipo de formato de salida (json, prop, xml), predeterminado: json
-file-in path – ruta del archivo de entrada
-file-out path – ruta del archivo de salida
-proxy url – Configuración del proxy HTTP (como URL http://user:password@hostname:port)
Ejemplos
ATENCIÓN! Los siguientes ejemplos están adaptados a los datos recopilados en el entorno de prueba. Para realizar comprobaciones en el entorno de producción, agregue el –keyid y –key parámetros con los valores adecuados a cada consulta.
1. Comprueba el estado actual del sistema VIES y muestra el resultado como XML:
viesapi-cli.exe -vies -format xml
2. Comprueba el estado actual de la cuenta y guarda el resultado en un archivo JSON:
viesapi-cli.exe -account -file-out result.json.
3. Descarga datos de la empresa de VIES y muestra el resultado como PROP:
viesapi-cli.exe -data -euvat PL5213003700 -format prop
4. Descarga los datos analizados de la empresa desde VIES y guarda el resultado en un archivo JSON:
viesapi-cli.exe -data-parsed -euvat PL5213003700 -file-out result.json
5. Carga un archivo por lotes (un número por línea) y recibe un token de lote para verificar el resultado:
viesapi-cli.exe -batch-upload -file-in numbers.csv
6. Comprueba el estado actual del lote y guarda el resultado en un archivo JSON:
viesapi-cli.exe -batch-download -token 1fd853a5-ac9e-490c-81a1-d4900a9c906c -file-out result.json