Huntarr API参考手册：完整接口说明和调用示例

Huntarr API参考手册完整接口说明和调用示例【免费下载链接】Sonarr-HunterAssists Sonarr to check for missing TV Shows项目地址: https://gitcode.com/gh_mirrors/so/Sonarr-HunterHuntarr是一款功能强大的Sonarr辅助工具专为帮助用户检查和管理缺失的电视剧集而设计。本API参考手册提供了Huntarr所有可用接口的详细说明和调用示例帮助开发者和高级用户充分利用Huntarr的强大功能。API基础信息Huntarr API采用REST风格设计所有接口均以/api/为前缀。API支持GET和POST两种HTTP方法返回数据格式均为JSON。基础URL所有API端点的基础URL为http://huntarr-server-ip:port/api/认证方式Huntarr API目前采用基于会话的认证机制用户登录后系统会自动管理认证状态。核心API接口获取系统状态接口信息端点:/api/health方法: GET描述: 获取Huntarr系统健康状态响应示例{ status: healthy, version: 1.0.0, database: connected, services: { sonarr: connected, radarr: disconnected } }获取所有配置接口信息端点:/api/settings方法: GET描述: 获取Huntarr的所有配置设置响应示例{ general: { timezone: Asia/Shanghai, language: zh-CN, check_for_updates: true, effective_timezone: Asia/Shanghai }, sonarr: { api_url: http://localhost:8989, api_key: your_sonarr_api_key, enabled: true }, // 其他应用配置... }图1: Huntarr主界面展示了API配置和系统状态信息获取功能标志接口信息端点:/api/settings/feature-flags方法: GET描述: 获取Huntarr的功能标志设置响应示例{ enable_requestarr: true, enable_media_hunt: true, enable_third_party_apps: true, dev_mode: false }保存通用设置接口信息端点:/api/settings/general方法: POST描述: 更新Huntarr的通用设置请求体示例{ timezone: Asia/Shanghai, auth_mode: local_bypass, check_for_updates: true, stateful_management_hours: 24 }响应示例{ success: true, message: General settings saved successfully }应用相关接口获取已配置应用接口信息端点:/api/configured-apps方法: GET描述: 获取所有已配置的应用列表响应示例[sonarr, radarr, lidarr, readarr]获取应用状态接口信息端点:/api/status/app_name方法: GET描述: 获取指定应用的连接状态URL参数app_name: 应用名称如sonarr、radarr等响应示例{ status: connected, version: 3.0.6.1342, last_sync: 2023-11-15T10:30:45Z }图2: Huntarr媒体搜索界面展示了通过API获取的媒体信息获取应用设置接口信息端点:/api/settings/app_name方法: GET描述: 获取指定应用的详细设置URL参数app_name: 应用名称如sonarr、radarr等响应示例{ api_url: http://localhost:8989, api_key: your_sonarr_api_key, enabled: true, search_frequency: 30, quality_profile: HD-1080p }更新应用设置接口信息端点:/api/settings/app_name方法: POST描述: 更新指定应用的设置URL参数app_name: 应用名称如sonarr、radarr等请求体示例{ api_url: http://newhost:8989, api_key: new_api_key, search_frequency: 60 }响应示例{ success: true, message: Sonarr settings updated successfully }高级功能接口获取周期状态接口信息端点:/api/cycle/status方法: GET描述: 获取所有应用的周期状态信息响应示例{ sonarr: { last_run: 2023-11-15T09:45:12Z, next_run: 2023-11-15T10:15:12Z, status: idle }, radarr: { last_run: 2023-11-15T09:30:05Z, next_run: 2023-11-15T10:00:05Z, status: idle } }重置应用周期接口信息端点:/api/cycle/reset/app_name方法: POST描述: 重置指定应用的周期计时器URL参数app_name: 应用名称如sonarr、radarr等响应示例{ success: true, message: Sonarr cycle reset successfully, next_run: 2023-11-15T09:50:23Z }图3: NZBHunt功能界面展示了通过API获取和管理的下载任务获取统计信息接口信息端点:/api/stats方法: GET描述: 获取Huntarr系统统计信息响应示例{ total_searches: 1245, successful_downloads: 876, failed_downloads: 56, apps: { sonarr: { searches: 845, downloads: 620 }, radarr: { searches: 400, downloads: 256 } } }实用工具接口测试通知接口信息端点:/api/test-notification方法: POST描述: 测试通知配置请求体示例{ provider: email, recipient: userexample.com }响应示例{ success: true, message: Test notification sent successfully }健康检查接口信息端点:/ping方法: GET描述: 简单的健康检查接口响应示例{ status: ok, timestamp: 2023-11-15T10:00:00Z }API使用示例以下是使用Python请求Huntarr API的简单示例import requests BASE_URL http://localhost:5000/api # 获取系统状态 response requests.get(f{BASE_URL}/health) print(response.json()) # 获取Sonarr设置 response requests.get(f{BASE_URL}/settings/sonarr) sonarr_settings response.json() print(fSonarr URL: {sonarr_settings[api_url]}) # 更新Sonarr搜索频率 new_settings { search_frequency: 45 } response requests.post(f{BASE_URL}/settings/sonarr, jsonnew_settings) print(response.json())图4: 请求管理界面展示了通过API创建和管理的媒体请求错误处理Huntarr API使用标准HTTP状态码表示请求结果200: 请求成功400: 请求参数错误401: 未授权404: 资源不存在500: 服务器内部错误错误响应格式{ success: false, error: 错误描述信息, code: ERROR_CODE }总结本手册详细介绍了Huntarr的API接口包括系统状态、配置管理、应用控制和高级功能等方面。通过这些API开发者可以轻松集成Huntarr的功能到自己的应用或脚本中实现自动化管理和扩展Huntarr的能力。如需了解更多关于Huntarr的信息请参考项目文档docs/【免费下载链接】Sonarr-HunterAssists Sonarr to check for missing TV Shows项目地址: https://gitcode.com/gh_mirrors/so/Sonarr-Hunter创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考