达人店后台管理系统接口说明

说明

此接口设计为restful风格API, 请求基于http(GET、POST、DELETE等方法)。

请求基本结构

GET

GET /shop/v1/trade/list? userName=mufeng&shopName=s1&from=[a] HTTP/1.1  
HOST: api.showjoy.com  
Cookie: key1=value1;key2=value2  
Connection: keep-alive  
Accept: */*  

POST

POST /shop/v1/authority/add HTTP/1.1  
HOST: api.showjoy.com  
Content-Type: application/json  
Content-Length:165  
Cookie: key1=value1;key2=value2  
Connection: keep-alive  
Accept: */*

[REQUEST_BODY]

请求属性说明

Cookie为用户登陆授权后返回的cookie信息,此部分用作本项目接口用户权限验证。  
REQUEST_BODY为JSON格式的请求体  
REQUEST_BODY = {  
    'userId': 25801,
    'userName': 'mufeng'
}

返回基本结构

1,接口用户权限验证不通过时跳转到登陆界面

HTTP/1.1 302 Found  
Content-Length:0  
Connection: keep-alive  
Location: http://loginx.showjoy.com/?service=http%3A%2F%2Fshopstatistics.showjoy.net%3A80&redirect_uri=%2FsystemAuthority  

2,正常请求

HTTP/1.1 200 OK  
HOST: api.showjoy.com  
Content-Type: application/json  
Content-Length:165  
Connection: close

[REQUEST_BODY]

REQUEST_BODY为JSON格式的请求体说明

    **正常返回**
    REQUEST_BODY = {
        'code': 1,
        'message': 'success',
        'pageCount': 1,
        'pageCurrent': 1,
        'data': {} || [],
        'isRedirect': 0,
        'redirect': 'url',
        'login': 0
    }
    1,正常返回code状态码均为1,非1为请求异常返回
    2,message为请求成功
    3,pageCount为分页请求时数据的总个数,pageCurrent为当前页的页数
    4,分页请求时data为JSON数组对象可综合pageCount和pageCurrent做出响应逻辑非分页请求时data为此次请求的详细信息
    5,isRedirect和redirect综合判断执行跳转
    6,login暂为兼容老系统之用
    **异常返回**
    REQUEST_BODY = {
        'code': 10001,
        'message': '请求错误原因的具体描述',
        'data': {} || [],
        'isRedirect': 0,
        'redirect': 'url',
        'login': 0
    }
    1,client可以根据code自行决定需要显示的内容,后续错误类型可以code扩展
    2,message字段为请求失败的原因(比如缺少某个字段、字段类型不正确等)
    3,data在异常返回无需处理
    4,isRedirect和redirect综合判断执行跳转
    5,login暂为兼容老系统之用

接口描述

GET请求参数均通过url参数提供, page默认值为1, pageSize默认值10

沐风

继续阅读此作者的更多文章