API 认证方式

安全可靠的API认证机制，保护您的数据和创作内容

认证机制
星尘织梦API使用Bearer Token认证，支持多种获取方式

安全性高

Token加密传输，定期轮换

权限控制

细粒度权限，按需授权

多端支持

CLI、Web、移动端通用

获取API Token

CLI登录获取
推荐

最简单的方式，登录后自动保存Token

# 交互式登录
$ novel login
Email: user@example.com
Password: ********
✓ 登录成功
Token已保存到 ~/.novel/config.json

查看Token

$ novel config get api.token
使用Token调用API

在请求头中携带Token进行API调用

curl -X GET https://api.novel-writer.cn/books \
  -H "Authorization: Bearer YOUR_TOKEN_HERE" \
  -H "Content-Type: application/json"
Token管理

Token刷新

Token有效期为30天，可使用refresh_token刷新

POST /auth/refresh
{
"refresh_token": "..."
}

Token撤销

主动撤销Token，立即失效

POST /auth/revoke
Authorization: Bearer TOKEN
API权限范围

不同的Token可以设置不同的权限范围

权限范围说明包含操作
read:books
读取作品查看作品列表、章节内容
write:books
写入作品创建、编辑、删除作品
read:analysis
读取分析查看拆书分析、模板
write:analysis
写入分析创建、发布分析模板
admin
管理权限所有操作权限
安全最佳实践
  • •不要在代码中硬编码Token，使用环境变量
  • •定期轮换Token，建议每月更换一次
  • •为不同用途创建不同的Token，方便管理
  • •使用HTTPS传输，避免Token泄露
  • •遵循最小权限原则，只授予必要权限
  • •监控Token使用情况，发现异常及时处理