API do MAXScanner v1
Crie fluxos de documentos, não infraestrutura de processamento.
APIs assíncronas para documentos, arquivos, OCR, conversão, PDF, compressão e webhooks. Um modelo de autenticação, um ciclo de vida de jobs e um contrato de resultados.
Autenticação
Chaves de API com escopo limitado
Processamento
Jobs assíncronos
Eventos
Webhooks assinados
Referência
Todas as operações da API
/api/v1/jobsCriar um job de processamento
Envie uma operação de processamento assíncrona e receba um identificador de job estável.
/api/v1/jobs/{jobId}Consultar o status do job
Leia o estado atual do ciclo de vida e as informações de resultado de um job de processamento.
/api/v1/documentsListar documentos
Lista os documentos disponíveis para a conta autenticada.
/api/v1/documents/{documentId}/processProcessar um documento
Crie um job de processamento assíncrono para uma versão de documento da conta.
/api/v1/files/uploadAutorizar o upload de um arquivo
Crie um fluxo de upload limitado para um arquivo de origem privado.
/api/v1/convertConverter um arquivo
Encaminhe uma conversão de documento compatível pela frota de processadores gerenciada.
/api/v1/ocrExecutar OCR
Extraia texto pesquisável de uma imagem ou documento compatível.
/api/v1/pdfExecutar uma operação de PDF
Envie uma operação de PDF compatível, como mesclar, dividir ou otimizar.
/api/v1/compressComprimir uma imagem
Envie um job de otimização de imagem com restrições de formato e qualidade.
/api/v1/webhooksCriar um webhook
Registre um destino de callback assinado para eventos de jobs e documentos.
Error referenceReferência de erros
Entenda erros de autenticação, validação, cota, conflito e servidor.
Limits & formatsLimites e formatos
Consulte os formatos compatíveis, as cotas e as restrições das requisições.