Datos procesados por Vantage Mobile Input

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:

Envío de parámetros de la sesión de entrada al Vantage Mobile Upload Backend
Obtención de parámetros de la sesión de entrada desde el Vantage Mobile Upload Backend
Obtención del estado de la transacción
Descarga de modelos para analizar imágenes de los documentos
Obtención de la lista de documentos de la transacción
Eliminación de documentos existentes en la transacción
Creación de un documento en la transacción
Carga de imágenes capturadas al documento
Inicio de la transacción

Plataforma Android

La microaplicación Vantage Mobile Input para Android utiliza las siguientes llamadas a la API:

Obtener el estado de la transacción
Descargar modelos para analizar imágenes de documentos
Obtener la lista de documentos de la transacción
Eliminar documentos existentes en la transacción
Crear un documento en la transacción
Cargar imágenes capturadas al documento
Iniciar la transacción

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

Vantage Mobile Input envía parámetros de sesión de entrada al Vantage Mobile Upload Backend. Estos parámetros se utilizan en la sesión de carga de la microaplicación de Android o del navegador web.

Parámetros de la sesión de entrada

Clave	Descripción
BaseURL	El dominio principal del servidor de Vantage.
TransactionID	El identificador de la transacción.
Token	El token de acceso de autorización codificado que se utiliza para acceder de forma autorizada a la Vantage API.
v	La versión de la Vantage API.
md	La cantidad de documentos que se capturarán en una sola transacción.
redirect_uri	El enlace de redirección que se abre cuando finaliza Vantage Mobile Upload.
dt	El tipo de documento.
ma	La dirección del entorno en la nube de ABBYY Vantage que se utiliza para iniciar microaplicaciones en implementaciones on-premises.

Solicitud:

curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions"
-H "accept: text/plain" \
-H "Content-Type: application/json" \
-F "Body=
    {
      "sessionAuxiliaryKey": "string",
      "sessionData": "string"
    }

Respuesta:

Código de estado de la solicitud

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

Para obtener los parámetros de la sesión de entrada, Vantage Mobile Upload envía solicitudes a Vantage Mobile Upload Backend.

Parámetros de la sesión de entrada

Clave	Descripción
BaseURL	El dominio principal del servidor de Vantage.
TransactionID	El identificador de la transacción.
Token	El token de acceso codificado que se utiliza para acceder con autorización a Vantage API.
v	La versión de Vantage API.
md	La cantidad de documentos que se capturarán en una sola transacción.
redirect_uri	El enlace de redirección que se abre una vez finalizada la carga móvil de Vantage.
dt	El tipo de documento.
ma	La dirección del entorno en la nube de ABBYY Vantage que se utiliza para iniciar microaplicaciones en instalaciones on-premises.

Solicitud:

curl -X POST "https://mobilesessionmanager-eu.abbyy.com/api/v1/mobilesessions/retrive"
-H "accept: text/plain" \
-H "Content-Type: application/json" \
-F "Body=
    {
      "userCode": "String"
    }

Respuesta:

{
   "sessionData": "<Input Session Parameters>"
}

Ejemplo de parámetros de la sesión de entrada:

{
\"sessionData\": \"https://mobilesessionmanager-eu.abbyy.com/mobile?baseUrl=<https://vantage-us.abbyy.com>&transactionId=<transaction-id>&token=<token>&v=<release_version>\"
}

Consultar el estado de la transacción

Vantage Mobile Upload envía una solicitud para obtener el identificador y el estado de la transacción. Solo las transacciones con el estado New son válidas para cargar documentos. Parámetros clave

Clave	Descripción
TransactionID	El identificador de la transacción.
Status	El estado de la transacción. Valores posibles: New, Started, Processing, Processed

Solicitud: Respuesta:

{
   "id": "<TransactionID>",
   "status": "<Status>"
}

Descarga de los modelos para analizar imágenes de documentos

La carga móvil de Vantage envía solicitudes para descargar modelos que detectan los bordes de las páginas en imágenes de documentos para la microaplicación de iOS. Parámetros clave

Key	Description
AbbyyRtrSDK-version	La versión del framework AbbyyRtrSDK que se utiliza para solicitar los archivos de patrones correspondientes. El valor puede variar según la versión de Vantage.
PatternFileName	El nombre del archivo de patrón de AbbyyRtrSDK que se utiliza para detectar los bordes de las páginas en imágenes de documentos. Hay seis tipos de archivos de patrón: `FactCrop.imodel`, `CnnCrop.Classifier.cnnmodel`, `DIQClassifier.imodel`, `CnnCrop.Detector.GenericWithID.cnnmodel`, `DIQBlockClassifier.imodel`, `CropClassifierPhoto.imodel`

Solicitud: Respuesta:

File pattern

Obtener la lista de documentos de la transacción

Antes de cargar documentos en la transacción, Vantage Mobile Upload envía una solicitud para comprobar si la transacción contiene documentos creados previamente. Si la transacción no está vacía, Vantage Mobile Upload envía una solicitud de Eliminar documento para eliminar todos los documentos existentes antes de iniciar una nueva sesión de carga. Parámetros clave

Key	Description
TransactionID	El identificador de la transacción.
DocumentID	El identificador del documento recibido de la solicitud Crear un documento.
SourceFileID	El identificador de la imagen del documento.
SourceFileName	El nombre de la imagen del documento. Vantage Mobile Upload genera automáticamente nombres de archivo para cada imagen y carga las imágenes en el documento mediante la solicitud Cargar imágenes en el documento.

Solicitud: Respuesta:

[
   {
      "documentId": "<DocumentID>",
      "sourceFiles": 
      [
         {
           "id": "<SourceFileID>",
           "name": "<SourceFileName>.JPG"
         }
      ]
   }, 
   {
      "documentId": "<DocumentID>",
      "sourceFiles": 
      [
         {
           "id": "<SourceFileID>",
           "name": "<SourceFileName>.JPG"
         }
      ]
   }
]

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.

Crear un documento en la transacción

Para cargar imágenes, Vantage Mobile Upload envía una solicitud para crear instancias de documento para cada documento de la transacción. Parámetros clave

Clave	Descripción
Token	El token de acceso codificado que se usa para autorizar el acceso a la Vantage API.
TransactionID	El identificador de la transacción.
DocumentID	El identificador del documento.

Solicitud: Respuesta:

{
   "documentId": "<DocumentID>"
}

Carga de imágenes capturadas al documento

Una vez que se ha creado la instancia del documento, Vantage Mobile Upload envía una solicitud para cargar todas las imágenes al documento. Todas las imágenes de un mismo documento se cargan en una sola solicitud. Parámetros clave

Key	Description
Token	El token de acceso de autorización codificado que se utiliza para acceder de forma autorizada a la Vantage API.
TransactionID	El identificador de la transacción.
DocumentID	El identificador del documento recibido en la solicitud Creación de un documento.
SourceFileID	El identificador de la imagen del documento.
SourceFileName	El nombre de la imagen del documento. Vantage Mobile Upload genera automáticamente nombres de archivo para cada imagen y carga las imágenes al documento.
ImageData	Los datos codificados de los archivos de imagen. Se utilizan para cargar imágenes a los documentos.

Solicitud: Respuesta:

Código de estado de la solicitud

Iniciar la transacción

Una vez creados todos los documentos y cargadas todas las imágenes en ellos, la carga móvil de Vantage envía una solicitud para iniciar la transacción. Parámetros clave

Clave	Descripción
Token	El token de acceso de autorización codificado que se utiliza para acceder de forma autorizada a la Vantage API.
TransactionID	El identificador de la transacción.

Solicitud: Respuesta:

Status code of the request

​Llamadas de API por plataforma

​Plataforma iOS

​Plataforma Android

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

​Parámetros de la sesión de entrada

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

​Parámetros de la sesión de entrada

​Consultar el estado de la transacción

​Descarga de los modelos para analizar imágenes de documentos

​Obtener la lista de documentos de la transacción

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

​Crear un documento en la transacción

​Carga de imágenes capturadas al documento

​Iniciar la transacción

Llamadas de API por plataforma

Plataforma iOS

Plataforma Android

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

Parámetros de la sesión de entrada

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

Parámetros de la sesión de entrada

Consultar el estado de la transacción

Descarga de los modelos para analizar imágenes de documentos

Obtener la lista de documentos de la transacción

Eliminación de documentos existentes en la transacción

Crear un documento en la transacción

Carga de imágenes capturadas al documento

Iniciar la transacción