🚀 灵动积木开放API

强大、安全、易用的RESTful API接口

📖 快速开始

📌 API基础信息
Base URL: https://api.jimuie.com/api/v1
协议: HTTP/HTTPS
数据格式: JSON
编码: UTF-8

认证方式

灵动积木API使用JWT Token认证。在请求头中携带以下信息：

Authorization: Bearer YOUR_ACCESS_TOKEN

响应格式

所有API响应都遵循统一的JSON格式：

{
    "code": 200,
    "message": "success",
    "data": { ... },
    "timestamp": 1698765432
}
🧪 前往API测试页面

🔐 认证授权

POST /auth/register
用户注册接口，创建新用户账号。

请求参数

参数名 类型 必填 说明
username string 是 用户名（3-20字符）
email string 是 邮箱地址
password string 是 密码（6位以上）

请求示例（注册）

{
    "username": "testuser",
    "email": "test@example.com",
    "password": "123456"
}

响应示例

{
    "code": 200,
    "message": "注册成功",
    "data": {
        "user_id": 123,
        "username": "testuser",
        "email": "test@example.com"
    },
    "timestamp": 1698765432
}
POST /auth/login
用户登录接口，获取访问令牌。

请求参数

参数名 类型 必填 说明
username string 是 用户名或邮箱地址
password string 是 密码

请求示例（登录）

{
    "username": "admin@jimuie.com",
    "password": "admin123"
}

响应示例

{
    "code": 200,
    "message": "登录成功",
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
        "user": {
            "id": 123,
            "username": "testuser",
            "email": "test@example.com"
        }
    },
    "timestamp": 1698765432
}

👤 用户信息

GET /auth/me
获取当前登录用户的详细信息。
⚠️ 注意：此接口需要认证，请在请求头中携带Token。

请求头

Authorization: Bearer YOUR_ACCESS_TOKEN

响应示例

{
    "code": 200,
    "message": "success",
    "data": {
        "id": 123,
        "username": "testuser",
        "email": "test@example.com",
        "balance": 1000.00,
        "vip_level": 1,
        "created_at": "2025-10-29 10:00:00"
    },
    "timestamp": 1698765432
}
GET /user/profile
获取用户的个人资料信息（与/auth/me功能相同）。

响应示例

{
    "code": 200,
    "message": "success",
    "data": {
        "id": 123,
        "username": "testuser",
        "email": "test@example.com",
        "nickname": "测试用户",
        "avatar": "https://...",
        "balance": 1000.00,
        "vip_level": 1,
        "vip_expire_at": "2025-12-31 23:59:59",
        "created_at": "2025-10-29 10:00:00"
    },
    "timestamp": 1698765432
}
POST /auth/change-password
修改当前用户的登录密码。

请求参数

参数名 类型 必填 说明
old_password string 是 原密码
new_password string 是 新密码（6位以上）

📜 脚本管理

GET /scripts
获取当前用户的脚本列表。

查询参数

参数名 类型 必填 说明
page int 否 页码（默认1）
page_size int 否 每页数量（默认20）
keyword string 否 搜索关键词

响应示例

{
    "code": 200,
    "message": "success",
    "data": {
        "items": [
            {
                "id": 1,
                "name": "测试脚本",
                "description": "这是一个测试脚本",
                "status": "draft",
                "created_at": "2025-10-29 10:00:00"
            }
        ],
        "pagination": {
            "total": 100,
            "page": 1,
            "page_size": 20,
            "total_pages": 5
        }
    },
    "timestamp": 1698765432
}
POST /scripts
创建新的脚本。

请求参数

参数名 类型 必填 说明
name string 是 脚本名称
description string 否 脚本描述
content object 是 脚本内容（JSON格式）

📋 任务管理

GET /tasks
获取当前用户的任务列表。

查询参数

参数名 类型 必填 说明
page int 否 页码（默认1）
status string 否 任务状态（pending/running/stopped）
POST /tasks
创建新的任务。
POST /tasks/:id/start
启动指定任务。
POST /tasks/:id/stop
停止指定任务。

💾 数据集管理

GET /datasets
获取当前用户的数据集列表。
POST /datasets
创建新的数据集。

请求参数

参数名 类型 必填 说明
name string 是 数据集名称
description string 否 数据集描述
structure array 是 数据结构定义
POST /datasets/:id/items
向数据集中批量添加数据项。

❌ 错误码说明

错误码 说明 解决方案
200 请求成功 -
400 请求参数错误 检查请求参数是否正确
401 未认证或Token失效 重新登录获取Token
403 无权限访问 检查用户权限
404 资源不存在 检查请求的资源ID
422 验证失败 检查输入数据格式
429 请求过于频繁 降低请求频率
500 服务器内部错误 联系技术支持
💡 提示：所有错误响应都会包含详细的错误信息，帮助你快速定位问题。