Developer Docs

API 接口说明

当前站点使用程序小店账号体系。用户先到 `shop.sanrenjz.com` 登录并购买 Python 会员,再到本项目创建 API Key 并调用数据接口。

1. 登录与会员

  • 网页登录入口:`/login/`
  • 程序登录接口:`POST /api/auth/shop-login/`
  • 会员购买页:`https://shop.sanrenjz.com/python`
  • 只有有效 Python 会员才可以创建 API Key 和调用 `/api/data/...`

2. 获取数据目录

GET /api/datatypes/
GET /api/tables/<data_type>/
GET /api/table/<table_id>/rows/

3. 创建 API Key

POST /api/keys/
Content-Type: application/json

{
  "data_type": "python_strategy"
}

网页端也可以在个人中心直接选择数据类型创建。

4. 调用数据接口

GET /api/data/<api_key>/
GET /api/data/<data_type>/<api_key>/

5. 管理员上传接口

POST /api/upload/?data_type=<name>&table=<name>
Content-Type: application/json 或 text/csv
需要管理员登录会话

JSON 上传示例

curl -X POST "https://api.sanrenjz.com/api/upload/?data_type=python_strategy&table=demo_table" \
  -H "Content-Type: application/json" \
  -b cookies.txt \
  --data '[{"amount": 12.5, "symbol": "000001", "signal": "buy"}]'

CSV 上传示例

curl -X POST "https://api.sanrenjz.com/api/upload/?data_type=python_strategy&table=demo_csv" \
  -H "Content-Type: text/csv" \
  -b cookies.txt \
  --data-binary $'12.5,000001,buy\n18.3,000002,sell'
Admin

管理员操作流程

  1. 登录 Django 后台 `/admin/`
  2. 维护 `DataType` 和 `DataTable`,或直接通过上传接口自动创建
  3. 上传 JSON/CSV 数据到对应 `data_type` 与 `table`
  4. 引导用户到程序小店购买 Python 会员
  5. 让用户在个人中心创建 API Key,并按文档调用接口
User

用户使用流程

  1. 到 `https://shop.sanrenjz.com` 注册并登录
  2. 购买 Python 会员
  3. 回到当前站点登录并同步会员状态
  4. 创建绑定到目标数据类型的 API Key
  5. 调用 `/api/data/<data_type>/<api_key>/`