Документация API

Обзор

API Orbitex позволяет встроить сжатие, объединение, разделение и конвертацию в ваши приложения, скрипты и конвейеры CI. Все запросы идут по HTTPS и требуют ключа API.

API находится в разработке. Эндпоинты, ограничения по частоте запросов и детали аутентификации будут опубликованы здесь до открытого бета-тестирования.

Аутентификация

Запросы содержат заголовок Authorization с вашим ключом API:

• Ключи создаются в панели Orbitex (тариф Business).
• Если ключ скомпрометирован, замените его в панели.
• Никогда не размещайте ключи в клиентском JavaScript или в публичных репозиториях.

Запланированные эндпоинты

В первую версию API войдут:

• POST /v1/pdf/compress - уменьшить размер файла PDF
• POST /v1/pdf/merge - объединить несколько файлов PDF
• POST /v1/pdf/split - разделить по страницам или диапазонам
• POST /v1/pdf/convert - PDF в Word и Excel и обратно
• POST /v1/pdf/protect - зашифровать с паролем
• GET /v1/jobs/{id} - запросить статус асинхронной задачи

Работа с файлами

К загруженным файлам применяются те же правила безопасности и удаления, что и в веб-интерфейсе. Сроки хранения и детали шифрования описаны в политике безопасности файлов.

Вебхуки сообщат вашему серверу о завершении долгих задач.

Ограничения по частоте запросов

Ограничения зависят от тарифа. Доступ к API на бесплатном тарифе не планируется. Клиенты Business получают задокументированные лимиты и запас на пиковые нагрузки.

Получить ранний доступ

Расскажите о своей задаче - пакетная конвертация, конвейеры документов, интеграция в SaaS - и мы сообщим вам, когда откроется бета-версия.