Хостинг и деплой
Создание окружений, запуск релизов и откат. Базовый адрес api.splitley.io/v3, аутентификация через заголовок Authorization: Bearer.
POST /v3/deployments
{
"project": "mediasfond",
"env": "production",
"tag": "v1.8.2"
}
Справочник разработчика
Документация и API Splitley Press
Справочный центр для разработчиков и администраторов. Быстрый старт в терминале, полный API-справочник с примерами кода и готовые интеграции с CMS и редакторами.
Раздел 01
Быстрый старт: первые шаги в терминале
Установите CLI, получите ключ и разверните первую инфраструктуру за пять минут — без единой строчки кода.
Шаг 1 — Установка
Установите CLI
Пакет splitley-cli доступен для macOS, Linux и Windows. Поддерживаются Homebrew, npm и бинарные сборки.
brew install splitley/tap/splitley-cli
# или
npm install -g @splitley/cli
Шаг 2 — Авторизация
Свяжите аккаунт
Введите токен из панели управления. Ключ хранится локально в ~/.splitley/credentials.
splitley login --token sk_live_8f3a…
✓ Связано с workspace «Медиафонд»
Шаг 3 — Развёртывание
Поднимите проект
Один запрос создаёт хостинг, CDN и хранилище архива. Конфигурация читается из файла splitley.yaml.
splitley deploy --env production
✓ Развёрнуто за 42 с → press.splitley.io
Шаг 4 — Проверка
Проверьте инфраструктуру
Отслеживайте статус узлов и задержки доставки контента по всем edge-точкам в реальном времени.
splitley status
12/12 узлов · TTFB 38 мс · аптайм 99,99 %
Раздел 02
API-справочник и примеры кода
REST-эндпоинты, версионирование и готовые сниппеты на JavaScript, Python и Go для типовых сценариев.
Архивы и поиск
Загрузка коллекций, версионирование объектов и мгновенный поиск по метаданным. Поддерживается пагинация курсорами.
GET /v3/archives?cursor=eyJpZCI6…
→ 200 OK · 248 объектов · next_cursorCDN и медиа
Управление edge-кэшем, преобразование изображений и написание правил доставки. Запросы в стиле GraphQL для гибких выборки.
mutation {
purgeCache(paths: ["/katalog/*"]) {
nodesPurged
}
}
Пример · Webhooks
Реакция на события деплоя
Подписывайтесь на события deployment.succeeded и archive.indexed, чтобы синхронизировать CMS с инфраструктурой. Подпись проверяется по заголовку X-Splitley-Signature.
app.post("/hooks/splitley", (req, res) => {
const event = req.body;
if (event.type === "deployment.succeeded") {
cms.publish(event.data.project, event.data.tag);
}
res.sendStatus(204);
});
Раздел 03
Интеграции с CMS и редакторами
Готовые коннекторы, которые связывают ваш редакторный цикл с инфраструктурой Splitley Press без ручного кода.
WordPress & Headless
Плагин splitley-bridge (v1.4) синхронизирует публикации и медиабиблиотеку. Автосинхронизация при сохранении, отправка в CDN — мгновенно.
ProseMirror & Slate
JS-библиотека @splitley/editor подключает live-превью и версионирование прямо в редакторную панель. Совместима с ProseMirror 1.x и Slate 0.73.
DAMS и оцифровка
Коннекторы к DSpace, Omeka и собственным DAMS-системам для каталогов и экспозиций. Экспорт в METS/ALTO и IIIF.
GitHub Actions
Официальный экшен splitley/deploy-action встраивает деплой в ваш пайплайн. Поддерживаются тег-триггеры, PR-превью и кэширование слоёв.
Метрики и логирование
Экспорт задержек, статуса узлов и событий в OpenTelemetry, Datadog и Prometheus. Метрики обновляются каждые 30 секунд.
EPUB, PDF & IIIF
Серверное конвертирование изданий в EPUB 3, PDF/A и IIIF-тилы. Задача через API, результат — готовый URL для скачивания.
Раздел 04
Часто задаваемые вопросы
Короткие ответы на то, что спрашивают чаще всего при подключении и работе с API.
Ключ создаётся в панели управления в разделе «Интеграции». Можно оформить отдельный ключ для каждого окружения и ограничить его правами — на чтение или на полный доступ.
Базовый лимит — 1200 запросов в минуту на проект. Для больших архивов и пакетной загрузки мы поднимаем квоту индивидуально и предоставляем отдельный канал для bulk-операций.
Да. Актуальная версия — v3, v2 остаётся доступной до конца 2025 года. Различия между версиями описаны в отдельной заметке о миграции с примерами переписанных запросов.
CLI поддерживает офлайн-режим: кэш индекса и метаданных хранится локально, изменения синхронизируются при восстановлении соединения. Полезно при полевых оцифровках в музеях.
Начните сейчас
Отпечатайте свою первую интеграцию
Скачайте CLI, откройте живой песочный workspace и проверьте API на реальных данных — бесплатно на первые 14 дней.