Встройте конвертацию файлов в своё приложение
REST API FileConvertFree позволяет конвертировать PDF и изображения из вашего приложения, серверной системы, автоматизации, корпоративного процесса или офисного ПО.
Быстрый старт
Тарифы и лимиты API
Лимиты общие для всей API-учётной записи и всех её ключей. Дополнительные ключи не увеличивают квоту.
Premium
200 / day- 200 Запросов в день
- 30 Запросов в минуту
- 200 MB Максимальный файл
- 3 Активных ключей max
Pro
400 / day- 400 Запросов в день
- 60 Запросов в минуту
- 200 MB Максимальный файл
- 3 Активных ключей max
Управление API-ключами
1. Создание ключа
В разделе API для разработчиков в Панели можно создать до 3 одновременно активных ключей. Давайте им понятные имена: Production, Office App, Staging и т. п.
2. Сохраните ключ сразу
Полный секрет показывается только после создания или перегенерации. FileConvertFree хранит защищённый хэш, а не открытый секрет, поэтому позже полный ключ показать нельзя.
3. Перегенерация ключа
При перегенерации создаётся новый секрет, а старый ключ немедленно отзывается. Обновите ключ в приложении и сохраните новый секрет до закрытия окна.
4. Отзыв ключа
Отзовите ключ, если он больше не нужен или мог попасть к посторонним. Он сразу перестаёт проходить авторизацию. Запись отозванного ключа автоматически удаляется через 7 дней.
Правила безопасности
Никому не передавайте API-ключ, не публикуйте его на GitHub, не вставляйте в JavaScript на стороне браузера, не отправляйте на скриншотах и не храните в публичном коде. Используйте переменные окружения сервера или менеджер секретов. При подозрении на утечку сразу перегенерируйте или отзовите ключ.
Доступные методы API
| Метод | Endpoint | Назначение / параметры |
|---|---|---|
| GET | /v1/account/usage | Проверка тарифа, статуса ключа, дневного расхода, остатка квоты и текущего лимита запросов. |
| GET | /health | Публичная проверка состояния API и версии. |
| POST | /v1/pdf/to-word | Конвертация корректного PDF в Word. |
| POST | /v1/pdf/to-excel | Конвертация корректного PDF в Excel. |
| POST | /v1/image/to-text | OCR: извлечение текста из изображения. Необязательное поле multipart: fast=true|false. |
| POST | /v1/image/to-word | Конвертация изображения в Word. Необязательное поле multipart: fast=true|false. |
| POST | /v1/image/to-excel | Конвертация изображения в Excel. Необязательное поле multipart: fast=true|false. |
| POST | /v1/image/remove-background | Удаление фона изображения. Необязательные поля: format (по умолчанию png), transparent=true|false, fast_mode=true|false. |
Примеры кода
Поддерживаемые файлы и проверка
PDF-методы принимают настоящие PDF-файлы. Методы для изображений принимают JPEG/JPG/JFIF, PNG, WebP, GIF, BMP и TIFF/TIF. API проверяет и расширение, и сигнатуру файла — простое переименование неподдерживаемого файла не обойдёт проверку.
Как возвращается результат
Методы конвертации возвращают готовый файл непосредственно клиенту. Image-to-text возвращает JSON. Внутренние ссылки конвертеров на скачивание внешним API-клиентам не раскрываются.
HTTP-ошибки и их значение
| Статус | Что означает | Причина / что делать |
|---|---|---|
| 401 | Ключ отсутствует, неверен, истёк или отозван. | Проверьте X-API-Key. После отзыва/перегенерации замените ключ на текущий. |
| 403 | Доступ к API не разрешён. | У аккаунта нет активного тарифа Premium или Pro. |
| 409 | Операция с ключом конфликтует с его состоянием. | Например: уже есть 3 активных ключа или выполняется перегенерация неактивного ключа. |
| 413 | Файл слишком большой. | Загрузите файл в пределах лимита API-тарифа (сейчас 200 МБ). |
| 415 | Неподдерживаемый или неверный тип файла. | Используйте поддерживаемый PDF/формат изображения и правильное расширение; API также проверяет сигнатуру. |
| 422 | Некорректное содержимое запроса. | Файл может быть пустым либо обязательные multipart-данные отсутствуют/некорректны. |
| 429 | Слишком много запросов. | Достигнут минутный лимит или общая дневная квота аккаунта. Повторите позже или дождитесь дневного сброса. |
| 5xx | Временный сбой API или сервиса конвертации. | Повторите запрос с задержкой. Серверные/инфраструктурные ошибки не списываются из дневной квоты. |
Как считается квота
Дневная квота и минутный лимит общие для всех ключей одного API-аккаунта. Неверные/неподдерживаемые загрузки, отклонённые до запуска конвертации, дневную квоту не расходуют. Серверные и инфраструктурные сбои возвращают зарезервированную дневную квоту. Запрос, принятый в конвертацию, может быть учтён, даже если внутренний конвертер позже вернул клиентскую ошибку 4xx. Дневная квота сбрасывается по календарному дню сервера/БД API.
Usage check: GET https://fileconvertfree.com/api1/v1/account/usage
Частые вопросы
Можно ли использовать API на Free?
Нет. Документация доступна всем, но для вызовов API сейчас нужен активный Premium или Pro.
Три ключа дают тройную квоту?
Нет. Все ключи используют общие дневные и минутные лимиты аккаунта.
Можно восстановить потерянный секрет?
Нет. Открытый ключ не хранится. Перегенерируйте ключ и сохраните новый секрет.
Что произойдёт после окончания платного тарифа?
Доступ к API отключается, если на основном сайте больше нет активного подходящего тарифа. Продлите Premium или Pro.
Готовы подключить FileConvertFree?
Создайте ключ в Панели, проверьте его через usage endpoint и подключите нужный метод конвертации.