Pular para o conteúdo principal
O Vantage Mobile Upload se comunica com o servidor do Vantage por meio de chamadas de API. Essas chamadas são usadas para criar documentos, fazer upload de imagens e iniciar o processamento de transações com determinados parâmetros.

​
Plataforma iOS

O microaplicativo iOS do Vantage Mobile Input utiliza as seguintes chamadas de API:
  1. Enviar parâmetros da sessão de entrada para o Vantage Mobile Upload Backend
  2. Obter parâmetros da sessão de entrada do Vantage Mobile Upload Backend
  3. Obter o status da transação
  4. Baixar modelos para análise de imagens dos documentos
  5. Obter a lista de documentos na transação
  6. Excluir documentos existentes na transação
  7. Criar um documento na transação
  8. Enviar (upload) imagens capturadas para o documento
  9. Iniciar a transação

​
Plataforma Android

O microaplicativo Android do Vantage Mobile Input utiliza as seguintes chamadas de API:
  1. Obter o status da transação
  2. Baixar modelos para analisar imagens de documentos
  3. Obter a lista de documentos da transação
  4. Excluir documentos existentes na transação
  5. Criar um documento na transação
  6. Enviar imagens capturadas para o documento
  7. Iniciar a transação

​
Envio de parâmetros de sessão de entrada ao backend de upload móvel do Vantage

Para registrar quando o usuário inicia a captura de documentos e de qual dispositivo, use POST /api/mobileinputbackend/v1/inputsessions. Este recurso aceita os seguintes parâmetros:

​
Parâmetros da sessão de entrada

ParameterTypeDescription
transactionIdstring (uuid)Obrigatório. Identificador da transação especificado no link de upload móvel.
platformstringObrigatório. Plataforma móvel do dispositivo onde o microaplicativo é aberto. Valores possíveis: iOS, Android, Web.
deviceModelstringOpcional. Modelo do dispositivo onde o microaplicativo é aberto.
OSVersionstringOpcional. Versão do sistema operacional do dispositivo onde o microaplicativo é aberto.
MIVersionstringOpcional. Versão do Vantage Mobile Input aberta pelo dispositivo.

​
Obtendo parâmetros da sessão de entrada do Vantage Mobile Upload Backend

Para verificar quando o usuário iniciou a captura de documentos, use GET /api/mobileinputbackend/v1/inputsessions/{transactionId}. Este recurso retorna os seguintes parâmetros:

​
Parâmetros da sessão de entrada

ParameterTypeDescription
transactionIdstring (uuid)Identificador da Transação especificado no link de upload em dispositivo móvel.
platformstringA plataforma móvel do dispositivo em que o microaplicativo é aberto. Valores possíveis: iOS, Android, Web.
deviceModelstringO modelo do dispositivo em que o microaplicativo é aberto.
OSVersionstringA versão do sistema operacional do dispositivo em que o microaplicativo é aberto.
MIVersionstringA versão do Vantage Mobile Input aberta no dispositivo.
createdAtstring (date-time)A data e a hora em que a sessão de entrada foi criada.

​
Obtendo o status da transação

Para verificar o status atual da transação ao capturar e fazer upload de documentos, use GET /api/publicapi/v1/transactions/{transactionId}. Este recurso retorna informações sobre a transação, incluindo:
  • transactionId. O identificador exclusivo da transação
  • status. Status atual da transação (New, Queued, InProgress, Processed, etc.)
  • createdAt. Quando a transação foi criada
  • documents. Array de documentos na transação

​
Baixando os modelos para analisar imagens de documentos

Para baixar modelos de machine learning que analisam imagens de documentos para detecção de qualidade e de tipo, use GET /api/mobileinputbackend/v1/models. Este endpoint fornece modelos que ajudam o app móvel a:
  • Detectar os limites do documento
  • Verificar a qualidade da imagem
  • Identificar tipos de documento
  • Validar as imagens capturadas

​
Obtendo a lista de documentos na transação

Para recuperar todos os documentos atualmente associados à transação, use GET /api/publicapi/v1/transactions/{transactionId}/documents. Esse recurso retorna um array de objetos de documento, cada um contendo:
  • id. Identificador do documento
  • name. Nome do documento
  • status. Status de processamento do documento
  • files. Array de arquivos (imagens) associados ao documento

​
Excluindo documentos existentes na transação

Para remover um documento da transação antes de iniciar o processamento, use DELETE /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}. Isso permite que os usuários:
  • Removam documentos capturados incorretamente
  • Limpem documentos antes de recapturá-los
  • Gerenciem conjuntos de documentos na transação
Observação: Os documentos só podem ser excluídos antes de a transação iniciar o processamento.

​
Criando um documento na transação

Para criar um novo documento na transação para envio de imagens, use POST /api/publicapi/v1/transactions/{transactionId}/documents. Exemplo de corpo da requisição: 
{
  "documents": [
    {
      "name": "Fatura",
      "index": 0
    }
  ]
}
Isso retorna um ID de documento que será usado para enviar imagens.

​
Carregando imagens capturadas para o documento

Para carregar imagens capturadas em um documento específico, use POST /api/publicapi/v1/transactions/{transactionId}/documents/{documentId}/sourceFiles. A solicitação deve incluir:
  • Dados de formulário com o(s) arquivo(s) de imagem
  • Metadados opcionais sobre cada arquivo
  • Opções de processamento de imagem (autoCrop, autoOrientation)
Formato da solicitação: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Files=@image1.jpg;type=image/jpeg" \
-F "Files=@image2.jpg;type=image/jpeg"

​
Iniciando a transação

Para iniciar o processamento de todos os documentos enviados na transação, use POST /api/publicapi/v1/transactions/{transactionId}/start. Isso inicia o fluxo de processamento com a skill especificada quando a transação foi criada. Exemplo de requisição: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "Authorization: Bearer token"
Após iniciar:
  • O status da transação muda para Queued ou InProgress
  • Os documentos são processados de acordo com a Skill configurada
  • Os resultados ficam disponíveis quando o status chega a Processed
  • Você pode acompanhar o progresso usando o endpoint de status da transação