Ir para o conteúdo principal

Encontre sua próxima ferramenta

Documentação/Primeiros passos/Início rápido da API: sua primeira conversão
Primeiros passos

Início rápido da API: sua primeira conversão

Crie uma chave de API, envie um arquivo, aguarde o job e baixe o resultado, com requisições prontas para copiar e colar.

Resposta curta

Crie uma chave em Painel → API e chaves e envie POST https://maxscanner.app/api/v1/jobs/ com a URL pública do arquivo, um nome de arquivo e o formato de destino. A API retorna um jobId na hora; consulte GET /api/v1/jobs/{jobId}/ a cada poucos segundos até que status seja "completed" e baixe output.downloadUrl em até cinco minutos.

Início rápido

  1. 1Abra Painel → API e chaves, escolha Criar chave de API, marque "Processar arquivos" e copie a chave (ela é exibida só uma vez).
  2. 2Guarde a chave em uma variável de ambiente, como MAXSCANNER_API_KEY, nunca em código do lado do cliente.
  3. 3Envie POST /api/v1/jobs/ com url, filename e format. Guarde o jobId da resposta 202.
  4. 4Consulte GET /api/v1/jobs/{jobId}/ a cada 2–10 segundos até que status seja completed ou failed.
  5. 5Baixe output.downloadUrl imediatamente: o link assinado expira após cinco minutos.

Antes de começar

Todas as requisições vão para https://maxscanner.app/api/v1/ e enviam a chave como token Bearer. As URLs das requisições terminam com barra: uma URL sem ela recebe um redirecionamento 308 que a maioria dos clientes HTTP segue, mas enviar a barra economiza uma ida e volta.

O plano Free permite 10 requisições por dia e 100 por mês, o suficiente para criar e testar uma integração. Os planos pagos usam créditos mensais; cada endpoint custa de 0 a 3 créditos.

  • URL base: https://maxscanner.app/api/v1/
  • Cabeçalho: Authorization: Bearer <your key>
  • Corpo: JSON com Content-Type: application/json
  • Arquivos: até 50 MB por importação via URL ou upload direto

Converta um arquivo do Word em PDF

O endpoint de jobs escolhe o processador certo a partir dos formatos de entrada e saída. Passe uma URL pública e o próprio servidor baixa o arquivo ao criar o job (até 50 MB em 30 segundos; redirecionamentos não são seguidos, então use o link final do arquivo); para arquivos privados, use um upload direto e passe sourceKey no lugar (veja o guia Arquivos e uploads). Adicione um cabeçalho Idempotency-Key para que uma requisição repetida nunca crie um segundo job.

curl -X POST 'https://maxscanner.app/api/v1/jobs/' \
  -H "Authorization: Bearer $MAXSCANNER_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: quickstart-0001' \
  -d '{ "url": "https://example.com/report.docx", "filename": "report.docx", "format": "pdf" }'

Aguarde o resultado

Os jobs são assíncronos para que arquivos grandes nunca mantenham sua conexão HTTP aberta. Consulte a URL de status começando com um intervalo de cerca de 2 segundos e aumentando até 10 segundos. Um arquivo pequeno do Office costuma terminar em menos de 20 segundos; um vídeo 1080p pode levar minutos. Quando status é completed, output traz o tipo de conteúdo, o tamanho em bytes e uma downloadUrl assinada.

curl 'https://maxscanner.app/api/v1/jobs/6f0c2a6e-8a1b-4a53-9a0e-2b1f4c9d7e11/' \
  -H "Authorization: Bearer $MAXSCANNER_API_KEY"

Próximos passos

Troque o polling por um webhook quando processar mais do que alguns poucos arquivos, leia o guia de jobs para conhecer as regras de nova tentativa e escolha o guia do recurso que corresponde à sua tarefa: OCR, ferramentas de PDF, imagens, mídia ou execução de um fluxo de trabalho salvo.

Perguntas frequentes

Preciso instalar um SDK?

Não. A API é simplesmente HTTPS e JSON, então funciona com qualquer linguagem ou ferramenta no-code capaz de enviar uma requisição HTTP. O guia de exemplos de código tem versões completas em Node.js, Python, PHP e cURL.

Por quanto tempo um link de download é válido?

Cinco minutos. Se ele expirar, consulte o status do job de novo para obter um link novo.

Existe um modo de teste?

Use o plano Free para testes: ele tem os mesmos endpoints e limita cada conta a 10 requisições por dia e 100 por mês.

Guias relacionados