Documentação para desenvolvedores
Crie com o MaxScanner.
Um guia completo sobre documentos, processamento, APIs, SDKs, automação e a extensão do Chrome, construído em torno de uma única conta e uma única plataforma de documentos.
Documentação do MAXScanner
Tudo o que é necessário para criar, processar, armazenar e automatizar documentos com o MAXScanner.
Ler o guia →Início rápido: seu primeiro documento processado
Vá do upload a um resultado salvo e reutilizável em minutos.
Ler o guia →Meus documentos
Entenda o espaço de documentos da conta e seu modelo de navegação.
Ler o guia →Pastas, grupos e páginas
Organize grandes coleções de documentos sem perder o controle no nível da página.
Ler o guia →Versões e artefatos
Saiba como os resultados do processamento se tornam um histórico duradouro do documento.
Ler o guia →Compartilhamento e links seguros
Projete um compartilhamento controlado de documentos sem expor URLs de armazenamento permanentes.
Ler o guia →Fluxos de ferramentas
Conecte ferramentas de PDF, imagem, OCR e documentos em jornadas de processamento repetíveis.
Ler o guia →Ferramentas de PDF
Arquitetura e experiência esperadas para as ferramentas de mesclar, dividir, comprimir, converter e OCR de PDF.
Ler o guia →Ferramentas de imagem
Redimensione, comprima, converta e otimize imagens com controles de saída previsíveis.
Ler o guia →Visão geral da API
Desenvolva sobre a superfície unificada da API do MAXScanner.
Ler o guia →Autenticação da API
Use chaves de API com escopo limitado e credenciais do lado do servidor com segurança.
Ler o guia →API de jobs
Crie, consulte e recupere jobs de processamento assíncronos.
Ler o guia →API de documentos
Pesquise documentos da conta e opere sobre eles.
Ler o guia →API de arquivos
Envie e recupere arquivos com fluxos limitados de armazenamento privado de objetos.
Ler o guia →API de OCR
Envie jobs de OCR e use o texto e os resultados pesquisáveis.
Ler o guia →API de conversão
Converta documentos entre formatos compatíveis pelo roteador de processadores.
Ler o guia →Webhooks
Receba eventos assinados de conclusão e falha de jobs.
Ler o guia →Erros e códigos de status da API
Entenda erros consistentes, falhas de validação, limites e estados de jobs.
Ler o guia →Formatos, limites e cotas
Consulte os formatos compatíveis, os limites de requisição e as cotas que dependem do plano.
Ler o guia →OpenAPI e referência da API
Mantenha um contrato legível por máquina para clientes gerados e ferramentas de desenvolvimento.
Ler o guia →Padrões de integração com SDK
Crie integrações confiáveis para JavaScript, Python e aplicativos do lado do servidor.
Ler o guia →Extensão do Chrome
Capture páginas web, capturas de tela e imagens e envie-as ao mesmo fluxo da sua conta MAXScanner.
Ler o guia →Segurança da extensão do Chrome
Proteja a autenticação, os uploads, as permissões e a troca de mensagens.
Ler o guia →Zapier
Conecte o processamento do MAXScanner à automação empresarial.
Ler o guia →n8n
Crie fluxos de processamento de documentos auto-hospedados.
Ler o guia →Automação com Zoho
Conecte o MAXScanner a CRM, Desk e fluxos empresariais com credenciais de API de escopo limitado e webhooks.
Ler o guia →Arquitetura de processamento
Entenda o gateway da API, a fila, o roteador, os workers, o armazenamento e o fluxo de versões do documento.
Ler o guia →Novas tentativas, idempotência e dead letters
Opere o processamento com segurança diante de falhas e reinícios de workers.
Ler o guia →Limites de processamento e concorrência
Controle o uso dos workers e proteja a plataforma contra cargas patológicas.
Ler o guia →Cobrança e planos
Entenda assinaturas, direitos de uso, créditos e consumo.
Ler o guia →Uso e medição da API
Meça o consumo da API e comunique as cotas aos clientes.
Ler o guia →Modelo de segurança
Isolamento de contas, RBAC, chaves com escopo limitado e armazenamento privado.
Ler o guia →Privacidade e retenção
Defina políticas de retenção, exclusão e processamento temporário de documentos.
Ler o guia →Referência do objeto de job
Entenda os campos canônicos retornados pelos jobs de processamento.
Ler o guia →Referência de eventos de webhook
Catálogo de convenções de payload de eventos e semântica de entrega.
Ler o guia →