Documentación de la API

Resumen

La API de Orbitex te permite integrar las operaciones de comprimir, unir, dividir y convertir en tus propias aplicaciones, scripts y canalizaciones de CI. Todas las peticiones usan HTTPS y requieren una clave de API.

La API está en desarrollo. Los endpoints, los límites de uso y los detalles de autenticación se publicarán aquí antes de la beta pública.

Autenticación

Las peticiones incluyen una cabecera Authorization con tu clave de API:

• Las claves se crean en tu panel de Orbitex (plan Business).
• Rota las claves desde el panel si alguna queda comprometida.
• Nunca expongas las claves en JavaScript del lado del cliente ni en repositorios públicos.

Endpoints previstos

La primera versión de la API incluirá:

• POST /v1/pdf/compress - Reducir el tamaño de un PDF
• POST /v1/pdf/merge - Combinar varios PDF
• POST /v1/pdf/split - Dividir por páginas o intervalos
• POST /v1/pdf/convert - De PDF a Word y Excel, y a la inversa
• POST /v1/pdf/protect - Cifrar con una contraseña
• GET /v1/jobs/{id} - Consultar el estado de un trabajo asíncrono

Tratamiento de archivos

Los archivos subidos siguen las mismas reglas de seguridad y eliminación que la interfaz web. Consulta la política de seguridad de archivos para conocer los plazos de retención y los detalles de cifrado.

Los webhooks avisarán a tu servidor cuando terminen los trabajos largos.

Límites de uso

Los límites de uso dependen del plan. No está previsto dar acceso a la API en el plan gratuito. Los clientes Business reciben límites documentados y márgenes para picos de tráfico.

Consigue acceso anticipado

Cuéntanos tu caso de uso - conversión por lotes, canalizaciones de documentos, integración SaaS - y te avisaremos cuando se abra la beta.