Ir para o conteúdo principal

API para Desenvolvedores

Acesso programático às conversões server-side do Converty.

A API v1 usa o mesmo pipeline de conversão da app web. Precisa de uma chave API emitida para o seu projeto.

Autenticação

Envie a sua chave API em cada pedido:

Authorization: Bearer YOUR_API_KEY
# or
X-API-Key: YOUR_API_KEY

Endpoints

URL base: https://api.example.com

  • GET /v1Metadados da API (sem chave necessária)
  • POST /v1/convert/documentPDF, Word, Excel, …
  • POST /v1/convert/audioaudio · video · image · archive · ebook · 3d
  • GET /progress/:jobIdStream Server-Sent Events
  • GET /download/:jobId?token=…Download assinado
  • POST /import/urlObter ficheiro remoto (corpo JSON { "url": "…" })

Categorias: document · audio · video · image · archive · ebook · 3d

Fluxo típico

  1. POST formulário multipart para /v1/convert/{category} com file, from, to e options JSON.
  2. Receba { jobId, estimatedSeconds }.
  3. Subscreva GET /progress/{jobId} (SSE) para estado em tempo real.
  4. Descarregue a partir do URL assinado no evento complete.
curl -X POST "https://api.example.com/v1/convert/document" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.pdf" \
  -F "from=pdf" \
  -F "to=docx" \
  -F 'options={}'

Limites

Limites de taxa standard aplicam-se por IP. Ficheiros devem corresponder a pares de formatos suportados. Ver registo de conversores para valores from/to válidos.

Precisa de limites mais altos ou chave dedicada? Contacte-nos.