Pular para o conteúdo principal
A plataforma ABBYY Vantage fornece duas APIs REST para integrar o processamento inteligente de documentos aos seus aplicativos:

API de Processamento

Envie documentos, gerencie transações e obtenha dados extraídos

API de Relatórios

Acesse dados analíticos e de relatórios de negócios

​
URL base

Todas as requisições à API são direcionadas ao servidor de produção do Vantage: 
https://vantage-us.abbyy.com

​
Autenticação

A Vantage API utiliza OAuth 2.0 para autenticação. Toda solicitação deve incluir um token de acesso no cabeçalho Authorization: 
Authorization: Bearer {your_access_token}
Vantage oferece suporte a três fluxos de autenticação:
FluxoMelhor para
Resource Owner Password CredentialsIntegrações servidor‑a‑servidor
Authorization Code FlowAplicações com interface para o usuário
Client CredentialsComunicação máquina‑a‑máquina
Entre em contato com a ABBYY para solicitar um tenant no ABBYY Vantage. Depois de obter uma conta de tenant, você poderá criar contas de usuário e clientes de API para autenticação.

​
API de Processamento

A API de Processamento (/api/publicapi/v1/) permite que você:
  • Crie transações — Envie documentos para processamento com um skill específico
  • Gerencie arquivos — Faça upload, edite e organize imagens de documentos
  • Acompanhe o status — Monitore o progresso da transação e trate erros
  • Recupere resultados — Baixe dados extraídos em formato JSON ou XML
  • Gerencie catálogos — Trabalhe com catálogos de dados e tabelas de consulta

​
Fluxos de trabalho comuns

Processe documentos com uma única solicitação que faz o upload, o processamento e a recuperação dos resultados automaticamente.Saiba mais →
Use chamadas de API separadas para ter controle mais granular sobre o envio de documentos, o processamento e a recuperação dos resultados.Saiba mais →
Integre a revisão manual ao seu fluxo de trabalho para documentos que exigem verificação humana.Saiba mais →

​
Reporting API

A Reporting API (/api/reporting/v2/) oferece acesso a:
  • Métricas de negócios — Volumes de transações, tempos de processamento e taxa de processamento (throughput)
  • Análises de qualidade — Precisão de extração e escores de confiança
  • Dados em nível de campo — Resultados de extração detalhados para análise
Saiba mais sobre Reporting →

​
Formatos de saída

Vantage fornece dados extraídos em formatos estruturados:

Saída JSON

Dados hierárquicos com detalhes completos de extração e índices de confiança

Saída XML

Marcação estruturada para sistemas que requerem integração em XML

​
Recursos para Desenvolvedores

Guia do Desenvolvedor

Guia completo para integração com a Vantage API

Coleção Postman

Coleção de API pronta para uso em testes e exploração

​
Limites de taxa e boas práticas

  • Operações em lote — Use endpoints em lote ao processar vários registros (até 5.000 registros de catálogo por solicitação)
  • Polling — Ao verificar o status da transação, use intervalos adequados (5–10 segundos)
  • Tratamento de erros — Implemente lógica de nova tentativa com backoff exponencial para erros temporários

​
Próximos passos

1

Configurar a autenticação

Configure a autenticação OAuth 2.0 para seu aplicativo
2

Processar seu primeiro documento

Siga o guia de processamento para enviar um documento
3

Explorar a API

Consulte as referências completas da Processing API e da Reporting API