API для разработчиков
Вызывайте инструменты из своих программ без браузера: отправьте запрос, запустите задачу и скачайте результат. Все эндпоинты доступны по единому версионированному адресу; каждый запрос авторизуется личным ключом.
Жизненный цикл задачи
Один запрос запускает задачу конвертации и возвращает ее ID. По этому ID вы проверяете статус задачи и скачиваете результат после завершения. Задачи могут занимать время, поэтому такое разделение позволяет клиентам ожидать без блокировки своих процессов.
Ключ и доступ
Запросы авторизуются с помощью заголовка Authorization: Bearer. Создайте ключ в личном кабинете и отзовите его в любой момент; ключ в открытом виде отображается только в момент создания. Сессия браузера здесь не считается авторизацией.
Инструменты с открытым API
| Инструмент | Уровень API | Документ |
|---|---|---|
| ImageShrink | Конвертер — POST /run | Документ |
| Income-Expense Ledger | 10 эндпоинтов (stateful-приложение) | Документ |
| PdfSplit | Конвертер — POST /run | Документ |
Версионирование и контракт
Эндпоинты версионируются в https://api.pixepi.com с префиксом /api/v1; обратно несовместимые изменения требуют новой версии. Машиночитаемый контракт опубликован в формате OpenAPI 3.1 и подходит для генераторов клиентов.
Ответы и ошибки
Ответы оборачиваются в JSON; статус каждой задачи запрашивается по ее ID, а права на запись проверяются на сервере. В случае ошибки возвращается код, описывающий состояние; клиент может преобразовать этот код на нужный язык.
Подробнее
- Ссылка на API на странице выбранного инструмента; открывает список его эндпоинтов, полей запроса, параметров и кодов ошибок.
- Машиночитаемый контракт: документ OpenAPI.
- Центральная страница разработчика: общий список всех эндпоинтов.