Saltar al contenido principal
Vantage Mobile Upload se comunica con el servidor de Vantage mediante llamadas a la API. Estas llamadas se utilizan para crear documentos, subir imágenes e iniciar el procesamiento de transacciones con determinados parámetros.

​
Llamadas de API por plataforma

​
Plataforma iOS

La microaplicación iOS de Vantage Mobile Input utiliza las siguientes llamadas a la API:
  1. Envío de parámetros de la sesión de entrada al Vantage Mobile Upload Backend
  2. Obtención de parámetros de la sesión de entrada desde el Vantage Mobile Upload Backend
  3. Obtención del estado de la transacción
  4. Descarga de modelos para analizar imágenes de los documentos
  5. Obtención de la lista de documentos de la transacción
  6. Eliminación de documentos existentes en la transacción
  7. Creación de un documento en la transacción
  8. Carga de imágenes capturadas al documento
  9. Inicio de la transacción

​
Plataforma Android

La microaplicación Vantage Mobile Input para Android utiliza las siguientes llamadas a la API:
  1. Obtener el estado de la transacción
  2. Descargar modelos para analizar imágenes de documentos
  3. Obtener la lista de documentos de la transacción
  4. Eliminar documentos existentes en la transacción
  5. Crear un documento en la transacción
  6. Cargar imágenes capturadas al documento
  7. Iniciar la transacción

​
Envío de parámetros de sesión de entrada al backend de carga móvil de Vantage

Para registrar cuándo el usuario comienza a capturar documentos y desde qué dispositivo, use POST /api/mobileinputbackend/v1/inputsessions. Este recurso admite los siguientes parámetros:

​
Parámetros de la sesión de entrada

ParameterTypeDescription
transactionIdstring (uuid)Obligatorio. Identificador de la transacción especificado en el enlace de carga móvil.
platformstringObligatorio. Plataforma móvil del dispositivo donde se abre la microaplicación. Valores posibles: iOS, Android, Web.
deviceModelstringOpcional. Modelo del dispositivo donde se abre la microaplicación.
OSVersionstringOpcional. Versión del sistema operativo del dispositivo donde se abre la microaplicación.
MIVersionstringOpcional. Versión de Vantage Mobile Input que abre el dispositivo.

​
Obtener parámetros de la sesión de entrada desde Vantage Mobile Upload Backend

Para verificar cuándo el usuario empezó a capturar documentos, use GET /api/mobileinputbackend/v1/inputsessions/{transactionId}. Este recurso devuelve los siguientes parámetros:

​
Parámetros de la sesión de entrada

ParameterTypeDescription
transactionIdstring (uuid)Identificador de la transacción especificado en el enlace de carga móvil.
platformstringPlataforma móvil del dispositivo donde se abre la microaplicación. Valores posibles: iOS, Android, Web.
deviceModelstringModelo del dispositivo donde se abre la microaplicación.
OSVersionstringVersión del sistema operativo del dispositivo donde se abre la microaplicación.
MIVersionstringVersión de Vantage Mobile Input que se abre en el dispositivo.
createdAtstring (date-time)Fecha y hora en que se creó la sesión de entrada.

​
Obtener el estado de la transacción

Para consultar el estado actual de la transacción al capturar y cargar documentos, use GET /api/publicapi/v1/transactions/{transactionId}. Este recurso devuelve información sobre la transacción, incluida:
  • transactionId. Identificador único de la transacción
  • status. Estado actual de la transacción (New, Queued, InProgress, Processed, etc.)
  • createdAt. Fecha y hora de creación de la transacción
  • documents. Matriz de documentos de la transacción

​
Descarga de modelos para analizar imágenes de documentos

Para descargar modelos de aprendizaje automático que analizan imágenes de documentos para la detección de calidad y de tipo, use GET /api/mobileinputbackend/v1/models. Este endpoint proporciona modelos que ayudan a la aplicación móvil a:
  • Detectar los bordes del documento
  • Comprobar la calidad de la imagen
  • Identificar tipos de documentos
  • Validar las imágenes capturadas

​
Obtener una lista de los documentos en la transacción

Para recuperar todos los documentos actualmente asociados con la transacción, use GET /api/publicapi/v1/transactions/{transactionId}/documents. Este recurso devuelve una lista de objetos de documento, cada uno de los cuales contiene:
  • id. Identificador del documento
  • name. Nombre del documento
  • status. Estado de procesamiento del documento
  • files. Lista de archivos (imágenes) asociados con el documento

​
Eliminación de documentos existentes en la transacción

Para eliminar un documento de la transacción antes de iniciar el procesamiento, use DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}. Esto permite a los usuarios:
  • Eliminar documentos capturados de forma incorrecta
  • Vaciar documentos antes de volver a capturarlos
  • Gestionar conjuntos de documentos en la transacción
Los documentos solo se pueden eliminar antes de que la transacción comience a procesarse.

​
Creación de un documento en la transacción

Para crear un documento nuevo en la transacción para subir imágenes, use POST /api/publicapi/v1/transactions/{transactionId}/documents. Ejemplo del cuerpo de la solicitud: 
{
  "documents": [
    {
      "name": "Factura",
      "index": 0
    }
  ]
}
Esto devuelve un ID de Document que se utilizará para subir imágenes.

​
Carga de imágenes capturadas en el documento

Para cargar imágenes capturadas en un documento específico, use POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles. La solicitud debe incluir:
  • Datos de formulario con los archivos de imagen
  • Metadatos opcionales para cada archivo
  • Opciones de procesamiento de imágenes (autoCrop, autoOrientation)
Formato de la solicitud:

​
Inicio de la transacción

Para iniciar el procesamiento de todos los documentos cargados en la transacción, use POST /api/publicapi/v1/transactions/{transactionId}/start. Esto inicia el flujo de procesamiento con la Habilidad especificada al crear la transacción. Ejemplo de solicitud: Después de iniciar:
  • El estado de la transacción cambia a Queued o InProgress
  • Los documentos se procesan según la Habilidad configurada
  • Los resultados estarán disponibles cuando el estado alcance Processed
  • Puedes seguir el progreso usando el endpoint de estado de la transacción