기존 앱 API

전문가

Sonarr나 Radarr만 아는 앱을 HolyArrs에 연결합니다. /sonarr나 /radarr로 끝나는 주소와 키를 주면 앱은 HolyArrs를 그 앱으로 여깁니다.

이런 앱만을 위해 만든 작은 API입니다. 직접 만든 스크립트에는 HolyArrs API를 쓰세요.

켜기

기본으로 꺼져 있습니다. 꺼져 있는 동안 /sonarr/와 /radarr/ 아래의 모든 주소는 404로 응답합니다.

Settings > API(설정 > API)를 여세요.
Requests from Seerr and Overseerr(Seerr와 Overseerr의 요청) 카드에서 Answer Seerr and Overseerr(Seerr와 Overseerr에 응답)를 켜세요.
Shows(시리즈) 옆의 Make key(키 만들기)를 누르세요. 이것이 Sonarr 쪽 키입니다. 한 번만 보여 주니 바로 복사하세요.
Movies(영화) 옆의 Make key를 누르세요. 이것이 Radarr 쪽 키입니다. 이것도 복사하세요.
카드에 나온 각 쪽의 주소를 적어 두세요. 예: /sonarr. URL base(기본 경로)가 있으면 /holyarrs/sonarr로 나옵니다. 카드에 나온 그대로 쓰세요.

최근에 비밀번호로 로그인하지 않았다면 키를 만들 때 비밀번호를 다시 묻습니다. 그다음 앱을 하나씩 설정하세요. 기존 앱 API 클라이언트를 보세요.

설정	하는 일	기본값
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는 자체 로그에서 그 값을 숨깁니다. 앞단의 리버스 프록시는 전체 주소를 로그에 남길 수도 있습니다.

키 규칙

각 쪽에는 이 카드에서만 만드는 전용 키가 있습니다. HolyArrs API 키(hak_로 시작)는 여기서 쓸 수 없고, 이 키들도 다른 곳에서는 쓸 수 없습니다.
키는 만든 사람의 자격으로 동작하며, 그 사람에게 라이브러리 관리 권한이 있어야 합니다. Prowlarr는 설정 변경 권한도 필요합니다.
그 사람이 꺼지거나 권한을 잃으면 누군가 새 키를 만들 때까지 앱이 거부됩니다. 카드가 경고해 줍니다.

HolyArrs API로 관리하기

비밀번호로 로그인한 상태여야 합니다. 키 호출에는 최근의 비밀번호 로그인이 필요합니다.

할 일	호출
스위치, 주소, 키 읽기	`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`)