HolyArrs API

வலை பயன்பாடு பயன்படுத்தும் அதே JSON API-ஐ /api/v1 கீழ், உங்கள் சொந்த script-களிலிருந்து அழைக்கலாம்.

முதல் அழைப்பைச் செய்யவும்

1. Settings > API > API keys (அமைப்புகள் > API > API விசைகள்) திறந்து, தேவையான வரம்புகள் மட்டும் உள்ள ஒரு விசையை உருவாக்கவும். அது ஒரு முறை மட்டுமே காட்டப்படும், எனவே இப்போதே நகலெடுக்கவும்.
2. ஒவ்வொரு அழைப்பிலும் அதை X-Api-Key header-இல் அனுப்பவும். முகவரியில் ஒருபோதும் வைக்க வேண்டாம்.
3. அடிப்படை முகவரி http://your-server:6262/api/v1-ஐ அழைக்கவும். URL base /holyarrs என இருந்தால், http://your-server:6262/holyarrs/api/v1-ஐ அழைக்கவும்.

export HOLYARRS_KEY=...your key...
curl -H "X-Api-Key: $HOLYARRS_KEY" "http://your-server:6262/api/v1/health"

JSON பதில் வரும். பிழைகள் {"error": "plain words"} வடிவில் HTTP நிலையுடன் வரும். ரகசியங்கள் மறைக்கப்பட்டு வரும்.

தேர்வுகள்

வரம்பைத் தேர்ந்தெடுக்கவும்

வரம்பு	அனுமதிப்பது
health_read	கண்காணிப்புக் கருவிகளுக்கான நல Feed மட்டும்
read	படிக்கும் வழிகள், நல Feed உட்பட
write	மாற்றங்கள், Admin வழிகள் மற்றும் கட்டுப்பாடுகள் தவிர
admin	மக்கள், அழைப்புகள், கோரிக்கை வரம்புகள், API விசைகள், கடவுச்சொற்கள் மற்றும் இரு-காரணி, உள்நுழைவு அமைப்புகள், மீட்டமைப்பு
control	பகுதி சுவிட்சுகள், பணி நிலைகள், இணைக்கப்பட்ட பயன்பாடுகள், மறுதொடக்கம் மற்றும் நிறுத்தம்
all	read, write மற்றும் admin. control சேராது

கண்காணிப்புக் கருவிக்கு health_read மட்டும் கொடுக்கவும், வேறு எதுவும் வேண்டாம்.

வழியைக் கண்டுபிடிக்கவும்

Settings > API அடிப்படை முகவரி, வரம்புகள், எடுத்துக்காட்டு அழைப்புகள், மற்றும் ஒவ்வொரு வழியின் வரம்பையும் அனுமதியையும் காட்டும். உள்நுழைந்திருக்கும்போது OpenAPI கோப்பு /api/v1/openapi.json-இல் கிடைக்கும். API வழிகள் எல்லா வழிகளையும் பட்டியலிடுகிறது.

முந்தைய பயன்பாடாக HolyArrs-உடன் பேசுதல்

Seerr, Overseerr, Bazarr போன்ற பயன்பாடுகள் இந்த API-ஐப் பயன்படுத்துவதில்லை. அவை HolyArrs-ஐ Sonarr மற்றும் Radarr போலவே நினைத்துப் பேசும், தங்களுக்கென்று தனி விசைகளுடன். முந்தைய பயன்பாடுகளுக்கான API பார்க்கவும்.

இது வேலை செய்யவில்லை என்றால்

அறிகுறி. ஒவ்வொரு அழைப்பிலும் 401. காரணம். விசை தவறானது அல்லது அழிக்கப்பட்டது. தீர்வு. புதிய விசையை உருவாக்கவும்.

அறிகுறி. ஒரு வழியில் மட்டும் 403. காரணம். விசையின் வரம்பு அந்த வழியை உள்ளடக்கவில்லை. தீர்வு. Settings > API-இல் அந்த வழியின் வரம்பைச் சரிபார்க்கவும்.

அறிகுறி. ஒவ்வொரு அழைப்பிலும் 404. காரணம். URL base விடுபட்டுள்ளது. தீர்வு. அதை /api/v1-க்கு முன் வைக்கவும். URL base பார்க்கவும்.

நிபுணர்களுக்கு

வழியைச் சேர்த்தல்

வழிகள் ஒவ்வொரு module-இன் routes.go-இல் உள்ளன. ஒவ்வொன்றும் அதன் முறை, பாதை மற்றும் அனுமதியுடன் பதிவு செய்யப்படுகிறது, எனவே ஒவ்வொரு வழிக்கும் அனுமதிச் சோதனை உண்டு.

openapi.json வழிகளிலிருந்து உருவாகிறது. அவை பொருந்தாமல் போனால் TestOpenAPIGenerated தோல்வியடையும், எனவே அதே மாற்றத்தில் அதையும் புதுப்பிக்கவும். snapshot புதுப்பிக்காமல் ஒரு வழியைச் சேர்த்தாலும், நீக்கினாலும், நகர்த்தினாலும் வழி-அட்டவணை snapshot-உம் தோல்வியடையும்.

வெளியிடப்பட்ட பிறகு, பாதைகளும் புலப் பெயர்களும் அப்படியே இருக்கும். புலங்களைச் சேர்க்கலாம், பெயர் மாற்ற வேண்டாம். மாற்றத்துக்குப் பிறகு, API வழிகள்-ஐ மீண்டும் எழுத go run ./app/backend/tools/apidoc இயக்கவும்.

Metadata server அழைப்புகள்

HolyArrs பெயர்கள், படங்கள் மற்றும் ஐடிகளை HolyArrs metadata server-இலிருந்து பெறுகிறது. ஒரு நிறுவலை வேறொரு server-க்குக் காட்ட HOLYARRS_METADATA_URL பயன்படுத்தவும். server code இந்த repo-வில் இல்லை.

பதிவு. முதல் தேடலில், நிறுவல் உடல் இல்லாமல் POST /v1/installations-ஐ அழைக்கிறது. பதில் 201, அதில் {"schema_version":1,"token":"hai_..."} இருக்கும். பயன்பாடு token-ஐக் குறியாக்கம் செய்து சேமித்து, ஒவ்வொரு தேடலிலும் Authorization: Bearer <token> அனுப்புகிறது. இது ஒரு முறை மட்டுமே பதிவு செய்கிறது. 401 வந்த பிறகு மீண்டும் பதிவு செய்யாது, எனவே ரத்து செய்யப்பட்ட நிறுவல் ரத்தாகவே இருக்கும். ஒரு முகவரிக் குழுவுக்கான மணிநேர வரம்பைத் தாண்டினால், பதில் 429 registration_limit, அதனுடன் Retry-After வரும்.

தேடல் (எல்லாம் GET)	வழி
தேடல்	/v1/search?provider=tmdb&kind=movie&q=Example&page=1
திரைப்படம்	/v1/movies/tmdb/{id}
தொடர்	/v1/shows/{tmdb or tvmaze}/{id}
பருவம்	/v1/shows/tmdb/{id}/seasons/{n} (பருவம் 0 என்பது சிறப்பு அத்தியாயங்கள்)
இசை	/v1/music/musicbrainz/{artist, release-group, release or recording}/{id}

தெரியாத அல்லது திரும்பத் திரும்ப வரும் அளவுருக்கள் மறுக்கப்படும். ஒரு வழங்குநரின் ஐடிகள் மற்றொன்றுக்குப் பயன்படுத்தப்படாது.

சரியான பதிலில் schema_version, source, source_id, fetched_at, expires_at, completeness, stale மற்றும் data இருக்கும். சுருக்கங்களில் உள்ள HTML-ஐ சாதாரண உரையாகக் கருதவும்.

நிலை	பொருள்
400	தவறான வினவல், மீண்டும் முயற்சிக்க வேண்டாம்
401	தவறான அல்லது ரத்து செய்யப்பட்ட token, மீண்டும் முயற்சிக்க வேண்டாம்
404	அந்தப் பதிவு இல்லை
429	மிக அதிக அழைப்புகள், Retry-After வரை காத்திருக்கவும்
503	அதிக சுமை, காத்திருந்து ஒரு முறை மீண்டும் முயற்சிக்கவும்

தொடர்புடையவை

• API வழிகள்
• முந்தைய பயன்பாடுகளுக்கான API
• சூழல் மாறிகள்