API

Концепции API

Разберитесь в аутентификации, асинхронных задачах и жизненном цикле API конвертации документов.

API PDF Craft основан на REST, использует JSON-запросы и ответы и аутентифицирует каждый запрос с помощью bearer API-ключа.

Базовый URL и аутентификация

Все эндпоинты доступны по адресу https://fusion-api.oomol.com/v1. Передавайте API-ключ через заголовок запроса Authorization.

text

Authorization: Bearer YOUR_API_KEY

Не раскрывайте этот ключ во фронтенд-коде. Направляйте работу, инициируемую из браузера, через ваш собственный бэкенд, когда конечный пользователь запускает конвертацию.

Жизненный цикл асинхронной задачи

Конвертация документов выполняется асинхронно. Эндпоинт отправки возвращает sessionID — идентификатор задачи, а соответствующий эндпоинт результата сообщает одно из следующих состояний:

processing: файл ожидает обработки или конвертируется.
completed: результат содержит URL сгенерированного выходного файла в data.downloadURL и его метаданные.
failed: результат содержит причину сбоя, которую ваше приложение должно отобразить или залогировать.

Ваша интеграция должна прекращать опрос при терминальном состоянии, использовать ограниченное количество повторных попыток и сохранять идентификатор задачи для поддержки и восстановления.

Эндпоинты

Текущий API поддерживает конвертацию PDF в Markdown и PDF в EPUB. Используйте полный API Reference для путей эндпоинтов, параметров, примеров полезной нагрузки, руководства по Python SDK и руководства по TypeScript SDK.