目录 API
开发者
外部 API 向图书馆、学校、教育和参考类服务提供 RusLit 目录:时代、作者和作品卡片,共五种语言。提交申请并经管理员审核后开通访问。
API 提供的数据
- 时代:名称、年代和介绍。
- 作者:姓名、生卒年和传记。
- 作品:标题、简介、创作经过、背景和趣闻。
- 目录:章节编号和标题。
- 两种尺寸的封面(WebP 和 JPEG),附来源和许可。
- 卡片的全部文字同时提供五种语言:俄语、英语、法语、西班牙语和中文,并附网站页面链接。
- 每条记录都有修改日期,并支持 updatedSince 过滤,只获取变更内容。
API 不提供章节正文:作品只能在网站上阅读。每张卡片都附有网站页面链接。
如何获得访问权限
- 在网站注册并确认电子邮箱。
- 在“我的应用”中提交申请:介绍应用并选择限额等级。
- 管理员审核申请,结果会通过邮件通知。首次批准开通 6 个月的访问权限。
- 创建应用密钥。密钥只显示一次,请妥善保存。
- 通过 OAuth 2.0(client credentials)获取令牌,并放在 Authorization 请求头中发送。令牌有效期为一小时。
- 访问到期前 30 天和 7 天会收到提醒。每次续期增加 12 个月。
限额等级
| 等级 | 每分钟请求数 | 每天请求数 |
|---|---|---|
| 基础 适用于大多数应用 | 60 | 10,000 |
| 扩展 适用于大型目录和频繁同步 | 600 | 200,000 |
限额按应用计算。超出限额时,API 返回 429 和 Retry-After 请求头。
主要规则
- 注明来源:“RusLit”,并链接到网站上的作品页面。
- 不得尝试从网站自动抓取章节正文,条款禁止这样做。
- 请在自己的系统中保存数据,并通过 updatedSince 更新,而不是每次都请求整个目录。
- v1 版本只会新增内容。不兼容的变更将在 v2 中发布,此后 v1 至少再运行 6 个月。