Manual de referencia
Introducción
El presente manual facilita la información de referencia necesaria para acceder a diversos módulos de servicios de DiezSCAN API. Los módulos actualmente disponibles son los siguientes:
Subida de documentos: Envío de documentos para su procesado.
Acceso a la API y sus servicios: Se podrá acceder a los servicios presentes en la API utilizando las claves de acceso facilitadas. Se pasarán a través del header de la cabecera de la petición HTTP.
Estados de documentos: Acceso a servicios que ofrecerán al usuario información relacionada con el estado de los documentos subidos por los clientes.
Informes o reportes: Acceso a servicios que ofrecerán al usuario información sobre los documentos y el estado de la facturación de DiezSCAN.
Entre ellos, damos la posibilidad de solicitar el número de documentos digitalizados filtrando el resultado por las fechas deseadas, un listado de los documentos actualmente pendientes de facturar por cliente, listado de documentos diarios subidos por cliente, informe de subida de documentos de su usuario, otro listado de documentos procesados por NIF filtrable por fechas y un listado donde obtendremos el uso de los NIFs por cliente.
Tipos de datos
Los tipos de datos de los campos se indicarán en las tablas de cada entidad de acuerdo a la siguiente denominación:
| Tipo | Descripción | |
|---|---|---|
Nullable (true/false) | Indica que el campo o propiedad puede ser nulo o estar vacío. | |
Integer ($int32) | Números enteros. | |
Decimal | Números con parte fraccionaria. | |
String | Cadenas de caracteres o cadenas de texto. | |
Boolean | Datos que solo pueden tomar los valores True y False. | |
Entidad | Tipo de dato compuesto de múltiples campos. Se facilita el nombre de la entidad correspondiente. | |
Array[entidad o campo(integer, string, ...)] | Lista de valores de un mismo tipo. | |
Enumerador (Array[integer]) | Listado de números enteros asociados a una descripción. Por ejemplo, el enumerador 1, estará asociado a el tipo de factura Emitida y el enumerador 2, a las facturas recibidas. | |
Binario($byte) | Archivos como PDF o imágenes |
Errores de las peticiones
Las funciones de la API de DiezSCAN devuelven diversos errores en caso de no poder completar su tarea satisfactoriamente. Dichos errores pueden agruparse en dos categorías: comunes y específicos. Estos últimos se detallan en el apartado correspondiente a cada función, tal y como se ha indicado antes. Las tablas siguientes muestran los errores de carácter genérico, aquellos que pueden producirse de forma general.
Errores básicos
| Código | Mensaje |
|---|---|
ERROR 5xx | Se ha producido un error no esperado al intentar conectar con el servidor. Ponte en contacto con soporte en soporte@diezsoftware.com |
ERROR 4xx | Se ha producido un error no esperado al realizar la operación. Ponte en contacto con soporte en soporte@diezsoftware.com |
Estos errores se producen por regla general cuando el JSON entregado al servicio está mal formado, la conexión con el servidor no esta operativa, se intenta invocar a una operación que no está implementada o bien no está permitida. Por favor, revise tanto el URL con el que está invocando al servicio como la estructura del JSON, incluyendo el tipo de los datos entregados. Si el problema persiste póngase en contacto con soporte en soporte@diezsoftware.com.