API каталога
Для разработчиков
Внешний API отдаёт каталог RusLit - эпохи, авторов и карточки произведений на пяти языках - для библиотек, школ, образовательных и справочных сервисов. Доступ открывается по заявке после проверки администратором.
Что отдаёт API
- Эпохи: названия, годы и описания.
- Авторы: имена, годы жизни и биографии.
- Произведения: названия, аннотации, история создания, контекст и интересные факты.
- Оглавление: номера и названия глав.
- Обложки в двух размерах (WebP и JPEG) с указанием источника и лицензии.
- Все тексты карточек сразу на пяти языках: русском, английском, французском, испанском и китайском, - и ссылки на страницы сайта.
- Дата изменения у каждой записи и фильтр updatedSince - чтобы забирать только изменения.
Тексты глав через API не отдаются: читать произведения можно только на сайте. Ссылки на страницы сайта есть в каждой карточке.
Как получить доступ
- Зарегистрируйтесь на сайте и подтвердите почту.
- Подайте заявку в разделе «Мои приложения»: опишите приложение и выберите уровень лимитов.
- Администратор рассмотрит заявку; о решении придёт письмо. Первое одобрение открывает доступ на 6 месяцев.
- Выпустите секрет приложения. Он показывается один раз - сохраните его в надёжном месте.
- Получайте токен по OAuth 2.0 (client credentials) и передавайте его в заголовке Authorization. Токен действует час.
- За 30 и за 7 дней до окончания доступа придёт напоминание. Продление добавляет 12 месяцев.
Уровни лимитов
| Уровень | Запросов в минуту | Запросов в сутки |
|---|---|---|
| Базовый для большинства приложений | 60 | 10 000 |
| Расширенный для крупных каталогов и частой синхронизации | 600 | 200 000 |
Лимиты считаются на приложение. При превышении API отвечает 429 с заголовком Retry-After.
Главные правила
- Указывайте источник: «RusLit» со ссылкой на страницу произведения на сайте.
- Не пытайтесь получать тексты глав с сайта автоматически - это запрещено условиями.
- Храните данные у себя и обновляйте их по updatedSince, а не запрашивайте весь каталог каждый раз.
- Версия v1 только дополняется. Ломающие изменения выйдут в v2, а v1 проработает после этого ещё не меньше 6 месяцев.
Условия использования API · Как мы обрабатываем данные партнёров