Documentação da API

Visão geral

A API da Orbitex permite integrar as operações de comprimir, juntar, dividir e converter aos seus próprios aplicativos, scripts e pipelines de CI. Todas as requisições usam HTTPS e exigem uma chave de API.

A API está em desenvolvimento. Endpoints, limites de taxa e detalhes de autenticação serão publicados aqui antes do beta público.

Autenticação

As requisições incluem um cabeçalho Authorization com a sua chave de API:

• As chaves são criadas no seu painel da Orbitex (plano Business).
• Gire as chaves pelo painel se alguma for comprometida.
• Nunca exponha chaves em JavaScript do lado do cliente nem em repositórios públicos.

Endpoints planejados

A primeira versão da API deve incluir:

• POST /v1/pdf/compress - Reduzir o tamanho do PDF
• POST /v1/pdf/merge - Combinar vários PDFs
• POST /v1/pdf/split - Dividir por páginas ou intervalos
• POST /v1/pdf/convert - PDF para Word, Excel e de volta
• POST /v1/pdf/protect - Criptografar com uma senha
• GET /v1/jobs/{id} - Consultar o status de tarefas assíncronas

Tratamento de arquivos

Os arquivos enviados seguem as mesmas regras de segurança e exclusão da interface web. Consulte a política de Segurança de arquivos para saber os prazos de retenção e os detalhes de criptografia.

Webhooks avisarão seu servidor quando tarefas demoradas terminarem.

Limites de taxa

Os limites de taxa dependem do nível do plano. Não há previsão de acesso à API no plano gratuito. Clientes Business recebem limites documentados e margens para picos.

Obter acesso antecipado

Conte para nós o seu caso de uso - conversão em lote, pipelines de documentos, integração SaaS - e avisaremos você quando o beta abrir.