API попередніх застосунків

Спрямуй на HolyArrs застосунок, який знає лише Sonarr або Radarr. Дай йому адресу, що закінчується на /sonarr або /radarr, і ключ, і він сприйматиме HolyArrs як той застосунок.

Це невеликий API, зроблений лише для таких застосунків. Для власних скриптів використовуй API HolyArrs.

Увімкнути

За замовчуванням воно вимкнене. Поки вимкнене, кожна адреса під /sonarr/ і /radarr/ повертає 404.

1. Відкрий Settings > API (налаштування > API).
2. На картці Requests from Seerr and Overseerr (запити від Seerr і Overseerr) увімкни Answer Seerr and Overseerr (відповідати Seerr і Overseerr).
3. Натисни Make key (створити ключ) біля Shows (серіали). Це ключ для боку Sonarr. Скопіюй його зараз; він показується один раз.
4. Натисни Make key біля Movies (фільми). Це ключ для боку Radarr. Скопіюй і його.
5. Запиши адресу для кожного боку з картки, наприклад /sonarr. З URL base вона виглядає як /holyarrs/sonarr. Використовуй те, що показує картка.

Якщо ти давно не входив із паролем, створення ключа попросить пароль ще раз. Потім налаштуй кожен застосунок: див. Клієнти API попередніх застосунків.

Обережно

Seerr зберігає ключі відкритим текстом у своєму файлі налаштувань. Тому Let these apps delete files вимкнено за замовчуванням.

Налаштування картки

Параметр	Що робить	Типово
Answer Seerr and Overseerr	Вмикає або вимикає /sonarr і /radarr разом.	Вимкнено
Make key / New key (новий ключ)	Створює ключ для цього боку. Новий ключ одразу зупиняє старий.
Remove key (прибрати ключ)	Видаляє ключ цього боку. Застосунки з ним отримують відмову.
Let these apps delete files (дозволити цим застосункам видаляти файли)	Коли вимкнено, видалення тайтла в застосунку лишає файли. Коли ввімкнено, файли спершу потрапляють у теку утримання, як при кожному видаленні в HolyArrs.	Вимкнено

Для кожного ключа картка показує його останні 4 символи, хто його створив і коли ним користувалися востаннє.

Для досвідчених

Як надсилати ключ

HolyArrs бере ключ із першого місця, де знайде, у такому порядку. Неправильний ключ у попередньому місці дає відмову, навіть якщо в наступному він правильний.

Порядок	Місце	Приклад
1	значення запиту apikey, у будь-якому регістрі	/sonarr/api/v3/series?apikey=KEY
2	заголовок X-Api-Key	X-Api-Key: KEY
3	заголовок Authorization, з Bearer або без	Authorization: Bearer KEY

curl -H "X-Api-Key: KEY" http://your-server:6262/sonarr/api/v3/system/status

Ключ у запиті приймається лише на цих адресах, і HolyArrs ховає його у власному лозі. Зворотний проксі перед ним усе одно може записувати повну адресу.

Правила щодо ключів

• Кожен бік має власний ключ, який створюється лише на цій картці. Ключі API HolyArrs (що починаються з hak_) тут не працюють, а ці ключі не працюють ніде більше.
• Ключ діє від імені людини, яка його створила, і їй потрібне право керувати бібліотекою. Prowlarr також потрібне право змінювати налаштування.
• Якщо цю людину вимкнено або вона втратила право, застосунки отримують відмову, доки хтось не створить новий ключ. Картка про це попереджає.

Керування через API HolyArrs

Потрібен вхід із паролем. Для викликів із ключами — недавній вхід із паролем.

Що	Виклик
Прочитати перемикачі, адреси й ключі	GET /api/v1/settings/old-app-api
Увімкнути	PUT /api/v1/settings/old-app-api з {"enabled": true}
Дозволити застосункам видаляти файли	PUT /api/v1/settings/old-app-api з {"delete_files": true}
Створити ключ для боку Sonarr	POST /api/v1/settings/old-app-api/keys/sonarr
Створити ключ для боку Radarr	POST /api/v1/settings/old-app-api/keys/radarr
Прибрати ключ	DELETE /api/v1/settings/old-app-api/keys/sonarr (або radarr)

Пов’язане

• Клієнти API попередніх застосунків
• Обмеження API попередніх застосунків
• Зворотний проксі та URL base