悠悠校园后台api

2015-05-19 本文已影响321人金发萌音

域名和端口

http://52.24.88.186:8888/

请求格式

对于POST和PUT请求,请求的主体必须是JSON格式,

错误返回

正确返回在详细中，所有出错返回均为

{
    'state':'error',
    'error':' error detail'
}

详细使用

用户认证

url: /1.0/auth
methed:post

发送参数

{
    type:'',
    phone_num:'',
    password:'',
}

{
    state:' ', //ok or error
    [error]:'',//when error

    [uid]:，// when ok
    [token]:'',

}

用户取消认证

本操作将删除设备令牌token

url:/v1.0/auth/{{uid}}/{{token}}
methed:delete

{
    state:'', //ok or error
    [error]:'', //error info when error
}

获取用户信息

url/v1.0/users/{{uid}}
methed get

{
    uid: ,
    sex: , // 0 for female, 1 for male
    username:'',
    phone_num:' ',
    score: ,
    qq:'',
    school:'',
    dept:'',
    sign,' ',
    enroll_year:'',//入学时间
    home_area:' ',
    home_city:'',
    home_province:' ',
    birthday:' ',
    constellation:' ',
    hobbies: ' ',
    image: ' '
}

注册

url`/v1.0/users
methed post

参数

{
    username = ''，
    image =''，
    sex = 1 or 0,
    phone_num = ' ',
    school = ' ',
    dept = ' ',
    enroll_year = ' ',入学时间
password = ' '//hash过
}

返回
```
{
    uid: ,
    token:'',
}
```

修改用户信息

url/v1.0/users
methed ：put

参数

{
    uid: ,
    token:'',
    sex: , // 0 for female, 1 for male
    username:'',
    phone_num:' ',
    score: ,
    qq:'',
    school:'',
    dept:'',
    sign,' ',
    enroll_year:'',//入学时间
    home_area:' ',
    home_city:'',
    home_province:' ',
    birthday:' ',
    constellation:' ',
    hobbies: ' ',
            image: ' ' ,
}

返回
```
{
    uid: ,
    token:'',
}
```

获取用户权限手机号是否公开，收藏是否公开

url: /v1.0/users/authority/{{uid}}/{{token}}/
methed:get
返回
```
{
    phone_pub:,
    coll_pub:
}
```

修改用户权限手机号是否公开，收藏是否公开

url: /v1.0/users/authority/{{uid}}/{{token}}
methed:put
参数
```
{
    phone_pub: ,
    coll_pub:
}
```
返回
```
{
    state:'' ,
}
```

查看签到信息

url: /v1.0/sign/{{uid}}/{{token}}
methed:get
返回
```
{
    sign:true or false
}
```

签到

url: /v1.0/sign/{{uid}}/{{token}}
methed:post
返回
```
{
    state:'ok'
}
```

搜索用户

url:/v1.0/users/search
methed:post

参数

    {
        'key_word':'',
        ['page']: ,
    }

获取分类商品

url:/v1.0/goods
methed:get

参数

{
    kind:,//表示商品分类
    sort_by:'',//排序方式（ 'multiple','date','view','price'，)
    [reversed]: true or false ,//如果存在则倒序排序，否则正序
    page: ,//每次返回20个,表示第几个20个
}

[
    {
        gid: ,
        name:'',
        views: ,
        price: ,
        date: ''，
        image:'',
    },
    ...
]

获取商品详情

url:/v1.0/goods/{{gid}}
methed: get
参数:
none

{
    gid: ,
    name: ' ',
    price: ,
    image:' ',
    user_info:{
        uid: ,
        username:' ',
        user_image: ' ',
        phone_num:' ',
        qq:' '
    }
    school:' ',
    old: ' ',
    date:' ',
    content: ' ', // 描述
    kind:{
        kind1_name:'',
        kind2_name:'',
    }
    views: ,

}

获取首页最新商品

url:/v1.0/new_goods
methed get

参数

{
    [page]: ,//一次返回20个商品，默认为 1 ，
}

[
    {
        gid: ,
        name:'',
        price: ,
        date: '',
        school: ''，
        image: ' ',
    },
    ...
]

搜索商品

url:/v1.0/goods/search
methed:post
参数
```
{
    key_word: ' ',
    [page]: ,
}
```

{
    gid: ,
    name: ,
    price: ,
    image: ,
    views: ,
    date: ' ',

}

发布商品

url: /v1.0/goods
methed: post

参数

{
    uid:
    token:' ',
    name:'',
    image:'',
    school:'', //商品所属学校校
    price: ,
    content:'', //描述
    kind: ,//分类信息
    old: '' // 新旧程度
}

返回
```
{
    state:'',  //ok or error
}
```

修改商品信息

url: /v1.0/goods
methed: put

参数

{
    uid:
    token:' ',
    name:'',
    image:'',
    school:'', //商品所属学校校
    price: ,
    content:'', //描述
    kind: ,//分类信息
    old: '' // 新旧程度
}

{
    state:'',  //ok or error
    [error]:'' , //error info when error
}

下架货物

url: /v1.0/goods/{{uid}}/{{token}}/{{gid}}
methed: DELETE

{
    state:'',  //ok or error
    [error]:'' , //error info when error
}

重新上架货物

* url: `/v1.0/goods/{{uid}}/{{token}}/{{gid}}`

* methed: `POST`

* 返回
    ```
    {
        state:'',  //ok or error
        [error]:'' , //error info when error
    }
    ```

获取分类求购

url: /v1.0/wants
methed: get

参数

{
    kind: ,
    sort_by:'',//'multiple','date','view','price'
    reversed:' ',
    {{page}}:' '
}

{
    wid: ,
    name:'',
    price: ,
    image: ,
    views: ,
    date: ,
    user_info:{
        uid: ,
        username: ,
        image:
    }
}

获取求购详情

url: /v1.0/wants/{{wid}}
methed: get

{
    wid: ,
    name:' ',
    views: ,
    price: ,
    content: ' ',
    school:' ',
    user_info:{
        uid: ,
        username:' ',
        image:' '
    },
    kind_info:{
        kind_name:' '
    }

}

获取首页最新求购信息

url: /v1.0/wants/index
methed: get
参数
```
{
    {{page}}
}
```

[
    {
        wid: ,
        name:' ' ,
        price: ,
        views: ,
        data:' ',
                    school:' ',
        user_info:{
            uid: ,
            username: ,
            image: ' '
        }
    },
    ....
]

搜索求购

url:/v1.0/wants/search
methed:post
参数
```
{
    key_word:' ',
    [page]:
}
```

发布求购信息

url: /v1.0/wants/{{uid}}/{{token}}
methed: post

参数

{
    uid:
    token:' ',
    name:'',
    image:'',
    school:'', //商品所属学校校
    price: ,
    content:'', //描述
    kind: ,//分类信息
    old: '' // 新旧程度
}

返回
```
{
    state:'',  //ok or error

}
```

修改求购信息

url: /v1.0/wants/{{uid}}/{{token}}
methed: put

参数

{
    uid:
    token:' ',
    name:'',
    image:'',
    school:'', //商品所属学校校
    price: ,
    content:'', //描述
    kind: ,//分类信息
    old: '' // 新旧程度
}

返回
```
{
    state:'',  //ok or error

}
```

删除求购信息

url: /v1.0/wants/{{uid}}/{{wid}}/{{token}}
methed: delete

返回
```
{
    state:'',  //ok or error
}
```

获取当前用户收藏商品信息

url:/v1.0/collections/goods
methed:POST

参数

{
    uid:' ',
    token: ' ',
    [page]:' '
}

{
    'user_info':{
        uid:,
        username: '',
        image:' ',
    },
    price:' ',
    state:' ',//状态 商品出售中或者已经下架
    gid: ' ',
    date: ' ',
    image:' ',
    name:' '
}

获取当前用户收藏求购信息

* url:`/v1.0/collections/wants`

* methed:`POST`

* 参数

    ```
    {
        uid:' ',
        token: ' ',
        [page]:' '
    }
    ```

* 返回
    ```
    {
        'user_info':{
            uid:,
            username: '',
            image:' ',
        },
        price:' ',
        state:' ',//状态 商品出售中或者已经下架
        wid: ' ',
        date: ' ',
        name:' '
    }
    ```

获取制定用户收藏商品信息

* url:`/v1.0/collections/goods/{{uid}}`

* methed:`GET`

* 参数

    ```
    {
        [page]:' '
    }
    ```

* 返回
    ```
    {
        'user_info':{
            uid:,
            username: '',
            image:' ',
        },
        price:' ',
        state:' ',//状态 商品出售中或者已经下架
        gid: ' ',
        date: ' ',
        image:' ',
        name:' '
    }
    ```

获取指定用户收藏求购信息

* url:`/v1.0/collections/wants/{{uid}}`

* methed:`GET`

* 参数

    ```
    {
        [page]:' '
    }
    ```

* 返回
    ```
    {
        'user_info':{
            uid:,
            username: '',
            image:' ',
        },
        price:' ',
        state:' ',//状态 商品出售中或者已经下架
        wid: ' ',
        date: ' ',
        name:' '
    }
    ```

新增商品收藏

url : /v1.0/collections/goods/{{uid}}/{{gid}}/{{token}}
methed: 'post',

返回
```
{
    state:' ok',
}
```

新增求购收藏

url : /v1.0/collections/wants/{{uid}}/{{gid}}/{{token}}
methed: 'post',

返回
```
{
    state:' ok',
}
```

删除商品收藏

url : /v1.0/collections/goods/{{uid}}/{{gid}}/{{token}}
methed: 'DELETE',

返回
```
{
    state:' ok',
}
```

删除求购收藏

url : /v1.0/collections/wants/{{uid}}/{{gid}}/{{token}}
methed: 'DELETE',

返回
```
{
    state:' ok',
}
```

获取一级分类分类信息

url/v1.0/kinds
methed:get

    {
        kid: ,
        name:' ',
        image:' '
    }

获取一级分类下所有二级分类信息

url/v1.0/kinds/{{ l_kid }}
methed:get

{
    s_kid: ,
    name:'',
    image:'',
}

获取商品评论

url:/v1.0/comments/goods/{{gid}}
methed:get
参数
{
[page]
}

{
    name: ' ',// 商品名
    comment:' ',
    to_user:{
        uid: ,
        username:' ',
        image:' '
    },
    from_user:{
        uid: ,
        username: ' ',
        image
    },
    gid,
    date:' '
}

获取求购评论

url:/v1.0/comments/wants/{{wid}}
methed:get
参数
{
[page]
}

{
    name: ' ',
    comment:' ',
    to_user:{
        uid: ,
        username:' ',
        image:' '
    },
    from_user:{
        uid: ,
        username: ' ',
        image
    },
    wid,
    date:' '
}

发布商品评论

url:/v1.0/comments/goods/{{gid}}//{{uid}}/{{token}}
methed:post
参数
{
'comment':' ',
}
返回
```
{
    'state':'ok'
}
```

发布求购评论

url:/v1.0/comments/wants/{{wid}}//{{uid}}/{{token}}
methed:post
参数
{
'comment':' ',
}
返回
```
{
    'state':'ok'
}
```

发送回执

url:/v1.0/feedback/{{uid}}/{{token}}
methed:post
参数
```
{
    'content':' '
}
```
返回
```
{
    'state':' '
}
```

上传图片

url :/v1.0/images
methed:post

参数 (编码格式 form-data)

{
    'image': '你的图片'，
    ‘uid': ,
    'token': ,
}

返回
```
{
    'hash':'',
    'key':' ',
}
```
访问方法
7xjejh.dl1.z0.glb.clouddn.com / + key
图片切割
- goods
  增加参数 ?imageView2/1/w/800/h/800/q/75/format/JPG 返回jpg格式 800*800 px 的图片
例子
上传图片后KEY 为 {{key}}
则 http://7xjejh.dl1.z0.glb.clouddn.com /{{key}}?imageView2/1/w/800/h/800/q/75/format/JPG
返回jpg格式 800*800 px 的图片

url:/v1.0/reposts/{{uid}}//{{token}}
methed:post

参数

{
    'id': , //gid or wid
   'type':' 举报商品还是求购'// good or want,
    'content':' 举报内容'
}

返回
```
{
    'state': 'ok', 
}
```

查看用户发布的商品

url:/v1.0/users/goods/{{uid}}/{{token}}
methed:get
参数
```
    {
           [page] : ',
    } 
```

 [
{
    "name": "",
    "views": ,
    "price": ,
    "gid": ,
    "date": "",
    "image": " "
},
...
]

查看用户发布的求购

url:/v1.0/users/wants/{{uid}}/{{token}}
methed:get
参数
```
    {
           [page] : ',
    } 
```

[
{
    "school": "",
    "wid": ,
    "name": "",
    "views": ,
    "price": ,
    "date": " "
},
...
]

悠悠校园后台api

域名和端口

请求格式

错误返回

详细使用

用户认证

用户取消认证

获取用户信息

注册

修改用户信息

获取用户权限手机号是否公开，收藏是否公开

修改用户权限手机号是否公开，收藏是否公开

查看签到信息

签到

搜索用户

获取分类商品

获取商品详情

获取首页最新商品

搜索商品

发布商品

修改商品信息

下架货物

重新上架货物

获取分类求购

获取求购详情

获取首页最新求购信息

搜索求购

发布求购信息

修改求购信息

删除求购信息

获取当前用户收藏商品信息

获取当前用户收藏求购信息

获取制定用户收藏商品信息

获取指定用户收藏求购信息

新增商品收藏

新增求购收藏

删除商品收藏

删除求购收藏

获取一级分类分类信息

获取一级分类下所有二级分类信息

获取商品评论

获取求购评论

发布商品评论

发布求购评论

发送回执

上传图片

举报

查看用户发布的商品

查看用户发布的求购

猜你喜欢

热点阅读