流物 - API文档

API概述

流物API基于RESTful架构设计，使用JSON作为数据交换格式。所有API请求都需要使用HTTPS协议。

基础信息

项目	说明
基础URL	`https://guchacha.cn/api`
数据格式	JSON
字符编码	UTF-8
认证方式	Bearer Token

统一返回格式

JSON

{
    "code": 0,
    "msg": "操作成功",
    "data": {
        // 具体数据内容
    }
}

状态码说明

状态码	说明
0	成功
400	请求参数错误
401	未授权，Token无效
403	权限不足
404	资源不存在
500	服务器内部错误

认证接口

用户认证相关接口，包括注册、登录和Token刷新。

用户登录

POST /api/auth/login

请求参数

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

返回示例

JSON

{
    "code": 0,
    "msg": "登录成功",
    "data": {
        "token": "eyJhbGciOiJIUzI1NiIs...",
        "user": {
            "id": 1,
            "nickname": "用户名",
            "email": "user@example.com"
        }
    }
}

刷新Token

POST /api/auth/refresh

提示

Token有效期为24小时，过期后需要使用刷新接口获取新Token

物品接口

物品档案管理相关接口，支持增删改查操作。

创建物品

POST /api/items

请求头

参数名	值
Authorization	`Bearer {token}`
Content-Type	`application/json`

请求参数

参数名	类型	必填	说明
name	string	必填	物品名称
category	string	必填	物品分类
brand	string	可选	品牌信息
description	string	可选	物品描述

查询物品

GET /api/items/{code}

路径参数

参数名	类型	说明
code	string	物品编码或溯源码

物品列表

GET /api/items

查询参数

参数名	类型	必填	说明
page	integer	可选	页码，默认1
limit	integer	可选	每页数量，默认20
category	string	可选	按分类筛选

条码接口

商品条形码查询接口，接入国家商品信息库。

查询条码

GET /api/barcode

请求参数

参数名	类型	必填	说明
key	string	必填	API Key
barcode	string	必填	商品条形码，8~13位数字

返回示例

JSON

{
    "code": 200,
    "msg": "success",
    "data": {
        "brand": "可口可乐",
        "found": true,
        "image": "",
        "price": "12.90",
        "barcode": "6920354825124",
        "company": "中粮可口可乐饮料有限公司",
        "category": "饮料",
        "goods_name": "可口可乐 碳酸饮料 330ml*6",
        "description": "",
        "specification": "330ml*6"
    },
    "time": 1770590000
}

注意

条码查询接口由第三方服务提供，请妥善保管您的API Key