ReadMeABook API Tokens完全指南：开发自动化脚本与第三方集成参考

【免费下载链接】ReadMeABookFully Featured audiobook request and downloading engine to bring audiobooks up to speed with the modern automation standards项目地址https://gitcode.com/gh_mirrors/re/ReadMeABook点击查看免费下载ReadMeABook API Tokens是这套有声书请求与自动下载引擎提供的静态个人令牌让你无需 JWT 会话就能用脚本、Home Assistant 或 Webhook 等第三方工具调用 API搜索有声书、创建请求、轮询下载状态。本指南面向新手带你 5 分钟掌握从创建 Token 到完成第一个自动化脚本的全部流程。为什么需要 API TokensReadMeABook 的日常使用靠网页登录会话JWT完成但当你想把发现新书 → 自动请求 → 监控下载写进自动化流程时登录 Cookie 就不适用了。此时 API Tokens 登场静态长令牌以rmab_为前缀生成后长期有效也可设置到期时间权限即本人Token 以创建者或其绑定的用户的完整用户级权限运行端点白名单Token 只能访问固定的 8 个接口比网页会话的权限面更小、更安全一次性显示完整 Token 只在创建时返回一次数据库仅保存 SHA-256 哈希快速上手3步创建你的第一把 Token进入个人设置登录后打开个人主页Profile找到API Tokens分区。界面位于 src/components/profile/ApiTokensSection.tsx点击 Create New Token填写名称如Home Assistant、Webhook并选择有效期Never永不过期30 days/90 days/1 year立即复制创建成功后会弹出绿色横幅展示完整 Token并提示Copy it now — it wont be shown again。错过就要删除重建因为系统只保存哈希值。 管理员还可在Admin → Users → API Tokens中代替任意用户创建 Token但 Token 角色始终与目标用户实际角色一致无法越权提升。该逻辑见 src/app/api/admin/api-tokens/route.ts。如何用 Token 调用 APIBearer 认证方式所有调用只需在请求头中携带 Token格式统一为Authorization: Bearer rmab_xxxcurl -H Authorization: Bearer rmab_your_token_here \ http://your-rmab-host/api/requests认证流程由中间件 src/lib/middleware/auth.ts 统一处理识别rmab_前缀 → 按 SHA-256 哈希查库 → 检查过期与用户软删除 → 校验端点白名单。白名单匹配器支持:id动态参数定义在 src/lib/constants/api-tokens.ts。项目还内置了交互式文档页/api-docs源码 src/app/api-docs/page.tsx可直接粘贴 Token 在浏览器里试跑每个端点非常适合新手调试。可用端点清单Token 能做什么以下是 API Token 白名单中的全部 8 个端点与网页会话相比是精简版权限方法路径用途写操作需管理员GET/api/auth/me获取当前用户信息GET/api/audiobooks/search搜索有声书?q关键词page1GET/api/requests列出可见的请求POST/api/requests创建有声书请求✅GET/api/requests/:id按 ID 查询单个请求详情GET/api/admin/metrics系统指标✅GET/api/admin/downloads/active进行中的下载✅GET/api/admin/requests/recent全用户最近请求✅白名单与文档元数据的唯一事实来源src/lib/constants/api-tokens.ts。管理端点右侧三个 ✅ 项适合接入自己的监控面板/api/admin/metrics返回请求总数、下载统计与库规模/api/admin/downloads/active返回进度、速度与预计完成时间——正好对应上图 Admin Dashboard 展示的核心指标。自动创建请求请求体字段与错误码最核心的写端点是POST /api/requests。请求体结构与网页版完全一致{ audiobook: { asin: B0ABC123, title: The Name of the Wind, author: Patrick Rothfuss, narrator: The Author } }行为与网页端一键请求保持一致查重检测、库内已有检查、忽略名单检查Token 请求会绕过忽略名单、自动审批规则、通知队列全部照常生效。响应为201 { success: true, request }若被拦截则返回具名错误AlreadyAvailable—— 库中已有此书BeingProcessed—— 正在处理中DuplicateRequest—— 重复请求Ignored—— 命中忽略规则UserNotFound/ValidationError小技巧追加查询参数?skipAutoSearchtrue可暂缓自动搜索任务适合先批量建单、稍后统一触发的场景。限流、数量上限与有效期规则写自动化脚本前务必了解这些护栏每用户上限 25 个未过期 Token超出返回403 Token limit reached创建限流每人每分钟最多 10 次创建尝试撤销限流每人每分钟最多 20 次撤销尝试触发限流返回429并携带Retry-After响应头脚本应据此退避重试限流规则实现见 src/lib/utils/rateLimit.ts数量上限常量见 src/lib/constants/api-tokens.ts。Token 数据模型name、tokenHash、lastUsedAt、expiresAt等字段定义在 prisma/schema.prisma。安全最佳实践像管理密码一样管理 Token立即存入密钥管理完整 Token 只出现一次泄露后无法找回只能撤销重建按用途命名home-assistant、nightly-script配合lastUsedAt字段可在列表中定位长期未用的 Token短有效期优先临时脚本选 30 天常驻集成再考虑更长周期及时撤销在 Profile → API Tokens 中点击Revoke即可立即失效使用中的集成会马上失去访问权限理解权限面Token 拥有绑定用户的完整用户级权限包括以你名义创建请求——切勿写入公开仓库或日志相关文件与源码参考想深入阅读实现按以下路径入手即可功能总览文档documentation/backend/services/api-tokens.md常量与白名单匹配器src/lib/constants/api-tokens.tsToken 生成工具随机字节 SHA-256src/lib/utils/api-token.ts用户自建接口创建/列表/撤销src/app/api/user/api-tokens/route.ts管理员接口src/app/api/admin/api-tokens/route.ts前端管理组件src/components/profile/ApiTokensSection.tsx交互式 API 文档页src/app/api-docs/page.tsx掌握以上内容你就能用 ReadMeABook API Tokens 把有声书请求流程无缝接入自己的自动化体系——从一条 curl 命令开始到监控面板全覆盖。赞分享【免费下载链接】ReadMeABookFully Featured audiobook request and downloading engine to bring audiobooks up to speed with the modern automation standards项目地址https://gitcode.com/gh_mirrors/re/ReadMeABook点击查看免费下载相关推荐终极Kavita RESTful API指南第三方集成与自动化脚本开发完全攻略终极Kavita RESTful API指南第三方集成与自动化脚本开发完全攻略 Kavita是一款功能强大、跨平台的阅读服务器专注于漫画阅读管理。作为开源项后端前端Overleaf API完全参考深度集成第三方应用的开发手册Overleaf API完全参考深度集成第三方应用的开发手册 概述 Overleaf作为业界领先的在线LaTeX协作编辑器提供了丰富的API接口允许开发者后端前端内容协同WebSocketGrafana API完全参考自动化运维和集成开发Grafana API完全参考自动化运维和集成开发 引言 在当今的DevOps和云原生环境中监控和可观测性变得越来越重要。Grafana作为一款领先的开源数可观测性指标监控数据可视化监控大盘告警后端前端日志分析创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考