J2EE前后交互接口

J2EE 接口文档

修改记录

登录

前端发送

{
    query:'login',
    data:{
        'email':,//用户的登录邮箱
        'password':,//用户的密码
    }
}

后台回复

{
    status:1/0,//1是登录成功，0是登录失败
    data:{
        userId:,//该用户的用户id
        userName:,//该用户的昵称
        sessionId:,//登录成功的时候返回这次登录的session_id
    }
    err:,//登录失败的时候返回出错原因
}

退出登录

前端发送

{
    query:'signout',
    data:{
        'userId':,//用户id
    }
}

后台回复

{
    status:1/0,//1是登录成功，0是登录失败
    err:,//登录失败的时候返回出错原因
}
后台需要销毁对应的session_id

找回密码

流程

1. 前端填写找回密码的邮箱，前端发送请求到后台请求密保问题

请求密保问题
前端发送

{
    query:"getPwQuestion",
    data:{
        email:,//用户的邮箱
        //该查询不需要验证
    }
}

后台回复

{
    status:0/1,//0是其它错误，1是成功
    data:{
        securityQuestion:,//用户的密保问题
    }
    err:,//出错信息，这种情况下出错一般是session对不上,或者数据库出错
}

2. 前端填写密保问题的答案，发到后台检验

检验密保答案
前端发送

{
    query:'checkAnswer',
    data:{
        email:,//
        answer:,
    }
}

后台回复

{
    status:1/0/,
    data:{
        changeId:,//问题回答成功时，生成一个changeId，作为这次操作的额外验证
    }
    err:,
}

3. 前端收到changeId,确认密保问题回答成功，输入新的密码，发送到后台完成流程

前端发送

{
    query:'findPassword',
    data:{
        email:,//用户的邮箱
        changeId:,//changeId必须和当前用户还有session对应，由上一步生成，用完这次就作废
        newPassword:,//新的密码
    }
}

后台回复

{
    status:1/0,
    err:
}

注册

前端发送

{
    query:'register',
    data:{
        userName:,//用户的昵称
        email:,//用户的邮箱,
        password:,//用户的密码
        securityQuestion:,//用户的密保问题
        securityAnswer:,//用户的密保答案
    }
}

后台回复

{
    state:1/0,//1是成功，0是失败
    err://失败的时候设置这个字段，表示出错原因
}

session检验

前端发送

{
    query:'check',
    data:{
        userId:,//用户的id
        sessionId,//用户的session_id
    }
}

后台回复

{
    status:1/0,//1代表检验正常，当前user_id和session_id是对应的，否则表示不对应
}

个人中心信息管理

修改密码

前端发送

{
    query:'changePassword',
    data:{
        userId:,//用户的id
        password:,//用户的旧密码
        newPassword:,//用户的新密码
        sessionId:,//用户的session_id
    }
}

后台回复

{
    status:0/1/-1,
    err:,//出错信息
}//解释见上

修改昵称

前端发送

{
    query:'changeName',
    data:{
        userId:,//用户的id
        newName:,//用户的新昵称
        sessionId:,//用户的session_id
    }
}

后台回复

{
    status:0/1/-1,
    err:,//出错信息
}//解释见上

请求地址簿

前端发送

{
    query:'getAddress',
    data:{
        userId:,//
        sessionId,//
    }
}

后台回复

{
    status:0/1/-1,
    err:,//出错信息
    data:{
        addresses:[
            {
                recipientName:,//收货人名字
                phoneNumber:,//电话
                addressDetail:,//地址
                isDefaultAddress:,//是否为默认地址
                addressId:,//地址的id
            }
        ]
    }
    //addresses是一个数组，每一个数组元素是一个java的map，每个map代表一个地址，包含四个字段
}

添加地址

前端发送

{
    query:'addAddress',
    data:{
        userId:,
        sessionId:,
        recipientName:,//收货人名字
        phoneNumber:,//电话
        addressDetail:,//地址
    }
}

后台回复

{
    status:0/1/-1,
    err:,//出错信息
    data:{
        addresses:[
            {
                recipientName:,//收货人名字
                phoneNumber:,//电话
                addressDetail:,//地址
                isDefaultAddress:,//是否为默认地址
                addressId:,//地址的id
            }
        ]
    }
    //addresses是一个数组，每一个数组元素是一个java的map，每个map代表一个地址，包含四个字段
}

修改地址

前端发送

{
    query:'editAddress',
    data:{
        addresses:[
            {
                recipientName:,//收货人名字
                phoneNumber:,//电话
                addressDetail:,//地址
                isDefaultAddress:,//是否为默认地址
                addressId:,//地址的id
            }
        ]
    }
    //addresses是一个数组，每一个数组元素是一个java的map，每个map代表一个地址，包含四个字段
}

后台回复

{
    status:0/1/-1,
    data:{
        userId:,
        sessionId:,
        recipientName:,//收货人名字
        phoneNumber:,//电话
        addressDetail:,//地址
        isDefaultAddress:,//是否为默认地址
        addressId:,//修改的address的id
    },//修改之后的地址信息
    err:,//出错信息
}

删除地址

前端发送

{
    query:'deleteAddress',
    data:{
        userId:,
        sessionId:,
        addressId:,//删除的address的id
    }
}

后台回复

{
    status:0/1/-1,
    err:,//出错信息
    data:{
        addresses:[
            {
                recipientName:,//收货人名字
                phoneNumber:,//电话
                addressDetail:,//地址
                isDefaultAddress:,//是否为默认地址
                addressId:,//修改的address的id
            }
        ]
    }
    ]//addresses是一个数组，代表删除成功之后的地址列表，每一个数组元素是一个java的map，每个map代表一个地址，包含五个字段.
}

图书展示

首页图书展示

前端发送

{
    query:'getRecent',
    data:{
        //该操作不需要验证
        number:,//请求的图书数量
    }
}

后台回复

{
    status:1/0,
    data:{
        products:[
        {
            itemTitle:,//商品标题
            itemId:,//商品id
            price:,//商品单价
            pictureAddress:,//图片的地址
        }]//products是一个数组，每一个数组元素是一个hashmap，有四个字段
    }，
    err:,
}

图书详情

前端发送

{
    query:'getItemDetail',
    data:{
        //该请求不需要验证
        itemId:,
    }
}

后台回复

{
    status:1/0,
    data:{
        product:{
            itemId:,//商品的id
            itemTitle:,//商品的标题 
            bookName,//书名
            author:,//作者 
            press:,//出版社  
            publicationTime:,//出版时间  
            sellerId:,//卖家 
            sellerName:,//卖家的名字
            freePostage:,//是否包邮,0/1  
            launchDate:,//发布时间  
            description:,//描述   
            price:,//单价   
            quantity:,//库存  
            pictureAddress:,//图片地址 
        }
    },
    err:,
}

图书搜索

前端发送

{
    query:'search',
    data:{
        pageNo:,
        itemsPerPage:,
        //该请求不需要验证
        name:,//搜索的内容
        bookCategory:['全部']//搜索的条件，这是一个字符串数组，可能的取值为['全部']/['小说','中国小说']/['教育','全部'],排在前面的标签优先级更高，全部表示搜索所有符合条件的结果
    }
}

后台回复：

{
    status:1/0,
    data:{
        items:[
        {
            itemTitle:,
            itemId:,
            price:,
            launchDate:,
            pictureAddress:,//图书图片地址
        }
        ],//一个包含了搜索结果的数组，每一个数组元素是一个结果，每一个结果五个字段
        size:,//搜索结果一共有多少
    },
    err:,
}

留言

查询留言

前端发送：

{
    query:'getQA',
    data:{
        //不需要验证
        itemId:,//当前商品的id
    }
}

后台回复：

{
    status:1/0,
    data:{
        QAList:[
            {
                questionContent:,
                responseContent:,//没有就是一个空字符串
                askerId:,//提问者的id
                sellerId:,//回答者的id
                askerName:,//提问者的昵称
                sellerName:,//回答者的昵称
                askTime,//提问的时间
                answerTime,//回答的时间
                questionId,//问题的id
            }
        ]//一个数组，每一个元素是包含一个问答信息
    },
    err:,
}

发布留言

前端发送：

{
    query:'sendAsk',
    data:{
        userId:,//提问者的id
        sessionId:,
        itemId:,//当前商品的id
        questionContent:,//问题内容
    }
}

后台回复：

{
    status:1/0/-1,
    err:,        
}

回复留言

前端发送：

{
    query:'sendAnswer',
    data:{
        userId:,
        sessionId:,
        answerContent:,
        questionId:,
    }//注意必须是卖家才能回复,如果已有回复的话就提示已有回复，status==0
}

后台回复：

{
    status:0/1/-1,
    err:,
}

消息管理

查询信息

前端发送

{
    query:'getMessage',
    data:{
        userId:,,
        sessionId:,
    }
}

后台回复

{
    status:1/0/-1,
    data:{
        messageList:[
        {
            messageId:,
            unread:,//已读，未读
            messageType:,
            launchTime:,
            afterServiceId:,
            orderId:,
            itemId:,
            quetionsId:,
            userName:,//发信息的人的昵称,在商品信息中用到
            question:,//1.1和2.1用到
            answer:,//1.1用到
            title:,//1.1和2.1用到
        }
        ]//一个信息列表
    },
    err:
}

获得一个订单的信息

前端发送

{
    query:'getOneOrder',
    data:{
        userId:,
        sessionId:,
        orderId:,
    }
}

后台回复

{
    status:1/0/-1,
    data:{
        order:{
          orderId:,
          purchaseTime:'2018-01-08 13:02',//按照这个格式
          itemTitle:,
          pictureAddress:,
          orderState:,
          totalPrice:,
          price:,
          quantity:,
          deliveryTime:,
          receiptTime:,
          expressCompany:,
          expressCode:,
          postage:,
          address_id:,//收货地址的id
          buyerName:,//买家的用户名
      }
    },
    err:
}

读信息

前端发送

{
    query:'readMessage',
    data:{
        userId:,
        sessionId:,
        messageId:,//读的信息id，是一个数组，每一个元素都是字符串，表示一个信息id（因为前端可能进行全部已读操作，所以会发一个数组）
    }
}

后台回复

{
    status:1/0/-1,//只有全部成功了才返回1
    err:,
    data:{
        messageId:[],//不管成不成功都要返回这个，一个messageId的数组，代表成功已读的messageId
    }
}

商品管理

上传图片

前端发送

{
    query:'uploadImg',
    file:,//一个图片,
    userId:,
    sessionId:,
}

后台回复

{
    status:1/0/-1,
    pictureAddress:,//上传成功时回复图片的地址
    err:,//失败时的报错
}

删除图片

前端发送

{
    query:'deleteImg',
    data:{
        userId:,
        sessionId:,
        pictureAddress:,//图片的地址
    }
}//必须要当前用户上传的图片才可以进行删除

后台回复

{
    status:1/0/-1,
    err:,
}

发布商品

前端发送

{
    query:'addBook',
    data:{
        userId:,
        sessionId:,//常规验证
        itemTitle:,//商品标题
        bookName:,//书的名字
        author:,//作者
        press:,//出版社
        publicationDate:,//出版日期
        bookCategory:,//标签，用于搜索的筛选，是一个字符串数组,长度可能为1或者2
        price:,//价格
        quantity:,//库存
        freePostage:,//是否包邮，0/1
        province:,//省
        city:,//市
        addressDetail:'',//默认退货地址
        phoneNumber:'',//默认退货电话
        sellerName:,//默认退货联系人
        description:,//详细描述
        pictureAddress:,//图片的链接。在发布商品之前会先执行上传图片操作，成功获得图片的url之后才会发送这个请求
    }
}

后台回复

{
    status:0/1/-1,
    err:,
}

查看已上架的商品

前端发送

{
    query:'getItemList',
    data:{
        userId:,
        sessionId:,
    }
}

后台回复

{
    status:1/0/-1,
    err:,
    data:{
        itemList:[
        {
            itemId:,
            itemTitle:,
            launchDate:,
            bookName:,
            pictureAddress:,
            quantity:,
            price:,
            freePostage:,
            itemState:,
        }
        ]
    }
}

下架商品

前端发送

{
    query:'deleteItem',
    data:{
        userId:,
        sessionId:,
        itemId:,
    }
}

后台回复

{
    status:1/0/-1,
    err:,
}

获取商品信息

前端发送

{
    query:'getBookDetail',
    data:{
        userId:,
        sessionId:,
        itemId:,
    }
}

后台回复

{
    status:1/0/-1,
    err:,
    data:{
        product:{
            itemTitle:,//商品标题
            bookName:,//书的名字
            author:,//作者
            press:,//出版社
            publicationDate:,//出版日期
            bookCategory:,//标签，用于搜索的筛选，是一个字符串数组,长度可能为1或者2
            price:,//价格
            quantity:,//库存
            freePostage:,//是否包邮，0/1
            province:,//省
            city:,//市
            addressDetail:'',//默认退货地址
            phoneNumber:'',//默认退货电话
            sellerName:,//默认退货联系人
            description:,//详细描述
            pictureAddress:,//图片的链接。在发布商品之前会先执行上传图片操作，成功获得图片的url之后才会发送这个请求
    }
}
}

编辑商品

前端发送

{
    query:'updateBook',
    data:{
        userId:,
        sessionId:,//常规验证
        itemId:,//修改的商品id
        itemTitle:,//商品标题
        bookName:,//书的名字
        author:,//作者
        press:,//出版社
        publicationDate:,//出版日期
        bookCategory:,//标签，用于搜索的筛选，是一个字符串数组,长度可能为1或者2
        price:,//价格
        quantity:,//库存
        freePostage:,//是否包邮，0/1
        province:,//省
        city:,//市
        addressDetail:'',//默认退货地址
        phoneNumber:'',//默认退货电话
        sellerName:,//默认退货联系人
        description:,//详细描述
        pictureAddress:,//图片的链接。在发布商品之前会先执行上传图片操作，成功获得图片的url之后才会发送这个请求
    }
}

后台回复

{
    status:0/1/-1,
    err:,
}

出售管理

查看全部订单

前端发送

{
    query:'getSellOrder',
    data:{
        userId:,
        sessionId:
    }
}

后台回复

{
    status:1/0/-1,
    err:,
    data:{
        orderList:[{
          orderId:,
          purchaseTime:'2018-01-08 13:02',//按照这个格式
          itemTitle:,
          pictureAddress:,
          orderState:,
          totalPrice:,
          price:,
          quantity:,
          deliveryTime:,
          receiptTime:,
          expressCompany:,
          expressCode:,
          postage:,
          address_id:,//收货地址的id
          buyerName:,//买家的用户名
          afterServiceId:,//售后的id
      }]//一个订单数组，每一个元素是一个订单
    }
}

查询地址信息

前端发送

{
    query:'getAddressDetail',
    data:{
        userId:,
        sessionId:,
        addressId:,//需要查询的地址id
    }
}

后台回复

{
    status:1/0/-1,
    err:,
    data:{
        recipientName:,//收件人名字
        province:,
        city:,
        addressDetail:,
        phoneNumber:,
    }
}

发货

前端发送

{
    query:'sendOrder',
    data:{
        userId:,
        sessionId:,
        orderId:,
        expressCode:,//快递编号
        express_company:,//快递公司
    }
}

后台回复

{
    status:1/0/-1,
    err:
}

购买管理

查看全部订单

前端发送

{
    query:'getBuyOrder',
    data:{
        userId:.
        sessionId:,
    }
}

后台回复

{
    status:1/0/-1,
    err:,
    data:{
        orderList:[{
          orderId:,
          purchaseTime:'2018-01-08 13:02',//按照这个格式
          itemTitle:,
          pictureAddress:,
          orderState:,
          totalPrice:,
          price:,
          quantity:,
          deliveryTime:,
          receiptTime:,
          expressCompany:,
          expressCode:,
          postage:,
          address_id:,//收货地址的id
          afterServiceId:,//售后的id
      }]//一个订单数组，每一个元素是一个订单
    }
}

支付

前端发送

{
    query:'payForOrder',
    data:{
        userId:,
        sessionId:,
        orderId:,//要支付的orderid
    }
}

后台回复:

{
    status:1/0/-1,
    err:,
}//后台需要自行更新订单状态为已支付

取消订单

前端发送

{
    query:'cancelOrder',
    data:{
        userId:,
        sessionId:,
        orderId:,//要取消的orderid
    }
}

后台回复:

{
    status:1/0/-1,
    err:,
}//后台需要自行更新订单状态

签收

前端发送

{
    query:'signOrder',
    data:{
        userId:,
        sessionId:,
        orderId:,//要签收的orderid
    }
}

后台回复:

{
    status:1/0/-1,
    err:,
}//后台需要自行更新订单状态

完成订单

前端发送

{
    query:'finishOrder',
    data:{
        userId:,
        sessionId:,
        orderId:,//要完成的orderid
    }
}

后台回复:

{
    status:1/0/-1,
    err:,
}//后台需要自行更新订单状态

申请售后

前端发送

{
    query:'requestService',
    data:{
        userId:,
        sessionId:,
        orderId:,//要申请售后的orderid
    }
}

后台回复:

{
    status:1/0/-1,
    err:,
}//后台需要自行更新订单状态

购物车

添加物品进购物车

前端发送

{
    query:'addBookToCar',
    data:{
        userId:,
        sessionId:,
        itemId:,
        quantity:,//添加的物品的数量
    }
}

后台回复

{
    status:1/0/-1,
    err:
}

获取购物车列表

前端发送

{
    query :  getShoppingCarList ,
    data :{
        userId : ,
        sessionId :
    }
}

后台回复

{
    status : 1/0,
    err :,
    data : {
        shoppingCarList:[
            {
                itemId:
                userName:
                itemTitle:
                price:
                quantity        //这个是库存
                picture:
                freePostage:
                province:
                itemState:  //是否下架
                nums :  //这个购物车数量
            }   
        ]
    }
}

改变购物车物品数量

前端发送

{
    query : changeShoppingCarNums ,
    data : {
        userId : '',
        sessionId : '',
        itemId : '',
        nums : ''  //购物车的数量
    }

}

后台回复

{
    status : 1/0,
    err :,
}

删除购物车项

前端发送

{
    query : deleteItemFromCar ,
    data : {
        userId : '',
        sessionId : '',
        itemId : ''
    }

}

后台回复

{
    status : 1/0,
    err :,
}

提交订单

前端发送

{
    query : submitBill ,
    data : {
        userId : '',
        sessionId : '',
        itemList : [
            {
                itemId:
                price:
                nums :  //购物车商品购买的数量
                postage : 
            },

        ],
        addressId : ''
    }

}

后台回复

{
    status : 1/0,
    data:{
        orderId:,//新生成的orderId
    }
    err :,
}

售后

获取售后服务列表

前端发送

{
    query : getAfterServiceList , 
    data : {
        userId : '',
        sessionId : ''
    }
}

后台回复

{
    status : 1/0/-1 ,
    err : '' ,
    data : {
        afterServiceList :[
            {
                afterServiceId :'',
                launchTime : '',
                returnReason : '',
                totalPrice : '',
                description : '',
                buyerName : '',
                phoneNumber : '',
                purchaseTime : '',
                orderId : '',
                itemTitle : '',
                pictureAddress:'',
                afterServiceState:'',
                sellerMessage: '',
                addressDetail: '',
                sellerName: '',
                sellerPhoneNumber: '',

            },

        ]
    }
}

获取一个售后服务

前端发送

{
    query : getOneAfterService , 
    data : {
        adminId : '',
        sessionId : '',
        afterServiceId: '',
    }
}

后台回复

{
    status : 1/0/-1 ,
    err : '' ,
    data : {
        service :{
                afterServiceId :'',
                launchTime : '',
                returnReason : '',
                totalPrice : '',
                description : '',
                buyerName : '',
                phoneNumber : '',
                purchaseTime : '',
                orderId : '',
                itemTitle : '',
                pictureAddress:'',
                afterServiceState:'',
                sellerMessage: '',
                addressDetail: '',
                sellerName: '',
                sellerPhoneNumber: '',

            }
    }
}

申请退货

前端发送

{
    query : applyReturn,
    data : {
        userId : '',
        sessionId : '',
        orderId : '',
        returnReason : '', 
        returnVoucher :'', 
        description : '' , 
        buyerPhoneNumber : ''
    }
}

后台回复

{
    status : 1/0/-1 , 
    err : '' ,
}

取消售后服务

前端发送

{
    query : cancelAfterService
    data : {
        userId : '',
        sessionId : '',
        afterServiceId :'',
    }
}

后台回复

{
    status : 1/0/-1,
    err : '' ,
}

申请平台介入

前端发送

{
    query : appeal
    data : {
        userId : '',
        sessionId : '',
        afterServiceId :'',
        description:'',//申请理由
        pictureAddress:,//凭证的图片地址
        name:,//联系人的名字
        phoneNumber:,//电话号码
        complaintType:1/2,//卖家：1，买家：2
    }
}

后台回复

{
    status : 1/0/-1,
    err : '' ,
}

退货

前端发送

{
    query : doReturn
    data : {
        userId : '',
        sessionId : '',
        afterServiceId :'',
        expressCompany : '', 
        expressCode : '',
    }
}

后台回复

{
    status : 1/0/-1,
    err : '' ,
}

获取卖家的售后服务列表

前端发送

{
    query:'getSellerAfterServiceList',
    data:{
        userId:,
        sessionId:
    }
}

后台回复

{
    status:1/0/-1,
    err:,
    data:{
        sellerAfterServiceList:[
            {
                afterServiceId : '',
                launchTime : '',
                returnReason : '',
                totalPrice : '',
                description : '',
                buyerName : '',
                phoneNumber : '',
                purchaseTime : '',
                orderId : '',
                pictureAddress : '' , 
                afterServiceState : '',
                itemTitle : ''
            }
        ]
    }
}

审核

前端发送

{
    query : Review
    data : {
        userId:
        sessionId:
        afterServiceId:
        reviewFlag:,//通过的时候reviewFlag为true，不通过为false
        sellerMessage:
        addressDetail:
        sellerName:
        province:'' ,
        city:'' , 
        sellerPhoneNumber: ''
    }
}

后台回复

{
    status : 1/0
    err : '' ,
    data : {

    }
}

完成售后

前端发送

{
    query : finishReturn
    data : {
        userId:
        sessionId:
        afterServiceId:
    }
}

后台回复

{
    status : 1/0
    err : '' ,
}

售后收货

前端发送

{
    query : afterSalesReceipt
    data : {
        userId:
        sessionId:
        afterServiceId:
    }
}

后台回复

{
    status : 1/0
    err : '' ,
}

客服系统

登录

前端发送

{
    query:adminLogin',
    data:{
        adminName:,
        password:,
    }
}

后台回复

{
    status:1/0/-1,
    err:,
    data:{
        adminId:,
        sessionId:,
    }
}

获取申诉列表

前端发送

{
    query:'getAppealList',
    data:{
        adminId:,
        sessionId:,
    }
}

后台回复

{
    status:1/0/-1,
    data:{
        appealList:[
            {
                complaintId:,
                complaintType:,
                sellerComplaintState:,
                description:,
                name:,
                phoneNumber:,
                launchTime:,
                afterServiceId:
            }
        ]
    }
}

同意申诉

前端发送

{
    query:'passAppeal',
    data:{
        adminId:,
        sessionId:,
        complaintId:,
        platformResponse:,
    }
}

后台回复

{
    status:1/0/-1,
    err:
}

拒绝申诉

前端发送

{
    query:'rejectAppeal',
    data:{
        adminId:,
        sessionId:,
        complaintId:,
        platformResponse:,
    }
}

后台回复

{
    status:1/0/-1,
    err:
}