@lina 2021-02-02T04:21:33.000000Z 字数 37787 阅读 1466

志多星前端1.0 接口文档

列表项
志多星 1.0 前端

1、项目约定

1.1 基本约定

1.1.1 API Base Url

【测试url】http://api.volunteer.alpha.guangying.link/api/v1

【线上url】/api/v1

1.1.2 鉴权字段(身份标识) 【6.0修改】

X-auth-token : [string] 登录后获取的 token 信息, 取window.token 请求头带此字段

X-org-code : [string]https://www.zybuluo.com/mdeditor# 机构表识字段,所有请求均需要此字段，取window.orgCode 请求头带此字段

X-location : [string] 坐标 lng-lat 请求头带此字段

X-unique-key : [string] 服务端下发的标识，取window.uniqueKey 请求头带此字段

X-city : [string] 所在城市名称请求头带此字段

X-platform-code : [string] 平台标识字段,所有请求均需要此字段，取window.platformCode 请求头带此字段

1.1.3 HTTP请求中字段要求

POST请求Content-Type为：Content-Type:application/x-www-form-urlencoded

文件上传时Content-Type为：Content-Type:multipart/form-data

对于：Content-Type:application/json：Content-Type:application/xml不保证完全支持，请谨慎使用

1.2 通用接口

1.2.1 通用接口URL

【线上url】待定

【测试url】http://api.volunteer.alpha.flashdiet.cn/api/

【线上url】/api/

1.2.2 上传图片

通用图片上传文件服务

请求URL

POST
/imgupload

请求参数

file : 文件

响应

{
    error_code: 0,
    data: {
        url: 'http://xxx'
    }
}

url : [string] 文件的访问URL

1.2.3 验证码图片

注：请求图片时，需解析图片的cookie，不然无法认证

GET
/captcha

1.2.4 发送短信

POST
/verifycode

请求参数

captcha_code : [string] 图形验证码

phone : [string] 手机号

响应

{
    error_code: 0,
    data: {
    }
}

1.2.5 城市列表接口

get
/city

请求参数

parent_id : [integer] 当不传值时，取parent_id=0的数据，即省、直辖市

响应

{
    error_code: 0,
    data: {
        "list": [
            {
              "id": 0,
              "parent_id": 0,
              "name": "string",
              "short_name": "string",
              "pinyin": "string",
              "sort": 0,
            }
        ]
    }
}

1.2.6 城市下区域接口【3.0新增】

get
/area/city

请求参数

name : [string] 城市名称

响应

{
    error_code: 0,
    data: {
        "list": [
            {
              "id": 0,
              "parent_id": 0,
              "name": "string",
              "short_name": "string",
              "pinyin": "string",
              "sort": 0,
            }
        ]
    }
}

1.3 通用响应字段

1.3.1 状态字段

error_code: [int] 服务器状态码，0 为正常状态，异常状态待定。

error_message：[string] 错误信息，但 error_code 不为 0 时返回

1.3.2 数据字段

data: [object] 数据字段，所有响应数据都在此字段中

list: [array]，当返回数据为列表时会将数据放在该字段

1.3.3 分页字段

page: [object] 分页信息，当返回数组数据时会携带该字段

current_page: [int] 当前页码，默认为1

total_page: [int] 总页数

page_size: [int] 每页数量：本项目常用page_size==10

示例

{
    error_code: 0,
    data: {
        key: value,
        list: [{
            key: value
        }],
        page {
        }
    }
}

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

sex:[int]

0: 未知
1: 男
2: 女

2.1.2 审核状态

verify_status:[int]

-1: 未提审
0: 审核中
1: 通过
2: 驳回

2.1.3 黑名单状态

in_blacklist:[int]

0: 不在
1: 在

jump_mode: [int]

0:不跳转
1:跳转指定url 取href字段
2:跳转项目 [后台暂未实现]
3:跳转团队 [后台暂未实现]

2.1.5 积分商品是否开启审核

examine: [int]

0:开启审核
1:关闭审核

2.1.6 积分商品上下架

is_display: [int]

0:上架
1:下架

2.1.7 积分商品订单审核状态

status: [int]

0:通过
1:已拒绝
2:待审核

2.1.8 积分商品是否领取

state: [int]

0:未领取
1:已领取

2.1.9 预算类型

budget_type: [int]

0:活动成本
1:管理成本
2:服务费

2.2.0 资助申请状态

status: [int]

0:待审核
1:已通过
2:被驳回
3:已撤销

2.2.1 项目project_status状态含义

status: [int]

2:招募中
3:进行中
4:已招满
5:已结束
6:招募截止
10:未提交
11:待审核
12:审核驳回
13:已下架

2.2 核心结构

2.2.1 用户信息【7.0修改】

{
    id: 123,
    username: '梦里花落知多少',
    phone: '15500000000',
    avatars: 'http://image.com/1.jpeg',
    real_name: '',
    nation: '汉族',
    sex: 0,
    birthday: 2013-03-03,
    identifier: 'V170924000008',
    slogan: '明天更美丽',
    reward_time: 12.5,
    id_number: 110101198803031321,
    province_id: 12,
    province_name: '河北',
    city_id: 1212,
    city_name: '保定',
    county_id: 121212,
    county_name: '望都县',
    addr: 'xx路xx小区',
    family_id: 0,
    relation: '儿子',
    join_family_time: '2017-09-09 13:13:13',
    good_at: [{}],
    join_project_count: 10,
    register_time: '2017-09-09 13:13:13',
    server_time: '2017-09-09 13:13:13',
    token:'aaaaaaa',
    email: 'aaa@163.com',
    score: 15,
    in_blacklist:1,
    have_pwd:1,
    stars: 1,
    achievement: 4,
    growth: 4000,
}

id: [int] 用户ID

username: [string] 用户名

phone: [string] 用户手机

avatars: [string] 头像

real_name: [string] 姓名

nation: [string] 民族

sex: [integer] 性别

birthday: [string] 生日

identifier: [string] 编号

slogan: [string] 口号

reward_time: [float] 奖励时长

id_number: [string] 身份证号

province_id: [integer] 省份id

province_name: [string] 省份名称

city_id: [integer] 城市id

city_name: [string] 城市名称

county_id: [integer] 区县id

county_name: [string] 区县名称

addr: [string] 地址

family_id: [integer] 家庭id，是否加入id

relation: [string] 与户主关系

join_family_time: [string] 加入家庭时间

good_at: [array] 个人擅长

join_project_count: 服务项目个数

register_time: 注册时间

server_time: 服务器时间

token: [string] token,用户登录态，仅登陆接口下发

email: [string] 用户邮箱

score: [integer] 分数

in_blacklist: [integer] 是否加入黑名单

have_pwd: [integer] 0没有，用户设置文案出“设置密码” 1有密码，用户设置文案出“修改密码”

stars: [integer] 星级

achievement: [integer] 完成成就个数

growth: [integer] 成长值

2.2.2 团队信息

{
    id: 123,
    name: '服务远征1号队',
    slogan: '服务为名',
    logo: 'http://image.com/1.jpg',
    photo: ['http://image.com/1.jpg',],
    team_photo: ['http://image.com/1.jpg',],
    type: '企事业单位'
    team_size: 111,
    identifier: 'aaa',
    contact_name: '张三',
    contact_phone: '18866666666',
    contact_addr: '某某省某某市',
    province_id: 12,
    province_name: '河北',
    city_id: 1212,
    city_name: '保定',
    county_id: 121212,
    county_name: '望都县',
    addr:'xx区'
    reward_time: 12.5,
    abstract: '团队市很棒的',
    created_at: '2017-03-03',
    parent: @团队信息
    category: @服务类别
    service_object: @服务对象
    join_type: 1
    join_status: 1
    collection_status: 1
    stars: 1,
｝

id: [integer] ID

name: [string] 团队名称

slogan: [string] 口号

logo: [string] logo

photo: [array] banner

team_photo: [array] 活动图

type: [string] 类型

team_size: [integer] 团队人数

identifier: [string] 编号

contact_name: [string] 联系人

contact_phone: [string] 联系人手机

contact_addr: [string] 联系人地址

province_id: [integer] 省份id

province_name: [string] 省份名称

city_id: [integer] 城市id

city_name: [string] 城市名称

county_id: [integer] 区县id

county_name: [string] 区县名称

addr: [string] 地址

reward_time: [int] 累计时长

abstract: [string] 简介

created_at: [string] 创建时间

category: [object] @服务类别

service_object: [object] @服务对象

parent: [object] @团队信息

join_type: [integer] 团队加入类型，1免审加入、2需要审核加入、3不允许任何人加入

join_status: [integer] -1未提交 0审核中 1通过 2驳回, 团队详情页,我的团队列表页，下发此字段

collection_status: [integer] 0未收藏 1已收藏, 团队详情页下发此字段

stars: [integer] 星级

2.2.3 项目信息【5.0修改】

{
    id: 123,
    name: '程序员慰问团',
    list_photo: 'http://image.com/1.jpg'
    photo: ['http://image.com/1.jpg',],
    identifier: '',
    province_id: '100100'
    province_name: '河北',
    city_id: 11,
    city_name: '保定',
    county_id: 11,
    county_name: '望都',
    addr: 'ssss',
    content: '富文本',
    join_end: '2017-10-10',
    begin: '2013-03-03 12:12:12',
    end: '2013-03-03 12:12:12',
    people_count: 133,
    join_people_count: 13,
    lng: 123.123433,
    lat: 40.984,
    reward_time: 13.5,
    created_at: '2017-11-11 11:11:11',
    project_status: 2,
    distance": 2554.5801072666,
    team: @团队信息
    category: @服务类别
    service_object: @服务对象
    join_status: 1,
    my_reward_time: 10,
    collection_status: 1
    contact_name: "张三",
    contact_phone: "133333333",
    contact_phone_public: 0,
    custom_config:{},
    custom_payment_config:{},
}

id: [integer] 活动ID

name: [string] 活动名称

list_photo: [string] 列表大图

photo: [array] 详情页轮播图

identifier: [string] 项目编号

province_id: [integer] 省份id

province_name: [string] 省份名称

city_id: [integer] 城市id

city_name: [string] 城市名称

county_id: [integer] 区县id

county_name: [string] 区县名称

addr: [string] 地址

content: [string] 富文本内容

join_end: [date] 结束报名时间

begin: [datetime] 活动开始时间

end: [datetime] 活动结束时间

people_count: [integer] 活动人数

join_people_count: [integer] 参加活动人数

lng: [float] 经度

lat: [float] 纬度

reward_time: [float] 活动时长／奖励时长

created_at: [string] 创建时间

project_status: [integer] 活动状态 '1'=>'未开始', '2'=>'招募中', '3'=>'已满员', '4'=>'进行中', '5'=>'已结束'

team: [object] @团队信息

category: [object] @服务类型

service_object: [object] @服务对象

join_status: [integer] -1没加入项目或者用户没登陆 0审核中 1通过 2驳回, 详情页下发，登陆后如加入项目才有此字段

my_reward_time: [float] 详情页下发，登陆后如加入项目才有此字段

collection_status: [integer] 0未收藏 1已收藏, 详情页下发此字段

contact_phone_public: [integer] 0不公开 1公开, 详情页下发此字段

contact_name: [string] 联系人

contact_phone: [string] 联系电话

custom_config: [array] 参考 2.2.20 仅详情页下发

custom_payment_config: [array] 参考 2.2.21

2.2.4 服务类型信息

{
    service_category_name:  '赛事服务'
｝

service_category_name: [string] 类型名称

2.2.5 服务对象信息

{
    service_object_name: 'aaa',
｝

service_object_name: [string] 服务对象名称

{
    id: 123,
    title: '活动',
    photo: 'http://image.com/111',
    jump_mode: 1,
    jump_id: 1,
    href: 'htttp://www.baidu.com',
    type:'0'
｝

id: [integer] ID

title: [string] title

photo: [string] 图片地址

jump_mode: [integer] 跳转类型

jump_id: [integer] 跳转id

href: [string] 跳转地址

type: [integer] banner类型 0首页 1积分商品

2.2.7 时长申请信息

{
    id: 123,
    project: @项目信息
    reward_time: 3.5,
    content: '文字描述',
    attachment: [],
    verify_status: 1,
    verify_msg: '通过',
｝

id: [integer] ID

project: [object] @项目信息

reward_time: [float] 申请时长

content: [string] 申请内容

attachment: [array] 附件

verify_status: [integer] 审核状态

verify_msg: [string] 审核内容

2.2.8 消息信息

{
    id: 123,
    type: 1,
    title: '标题',
    content: '文字描述',
    publish_time: '2017-09-25 23:05:23',
    username: "wang59",
    avatars: "http://image.com/1.jpeg"
｝

id: [integer] ID

type: [float] 类型 0全量消息，1单发消息

title: [string] 标题

content: [string] 内容

publish_time: [string] 发布时间

username: [string] 消息发送人

avatars: [string] 消息发送人头像

2.2.9 打卡信息

{
    "id": 22,
    "clock_in_time": "2017-11-27 13:59:44",
    "clock_end_time": "0000-00-00 00:00:00",
    "type": 1,
    "apply_id": 0,
    "clock_in_addr": "",
    "clock_in_lat": 0,
    "clock_in_lng": 0,
    "clock_end_addr": "",
    "clock_end_lat": 0,
    "clock_end_lng": 0,
    "reward_time": "3.00"
｝

id: [integer] ID

clock_in_time: [string] 打卡or签到时间

clock_end_time: [string] 签退时间

type: [integer] 补卡or正常打卡 type=0 补卡 type=1正常打卡

apply_id: [integer] 补卡id

clock_in_addr: [string] 打卡or签到地点

clock_in_lat: [float] 打卡or签到纬度

clock_in_lng: [float] 打卡or签到经度

clock_end_addr: [string] 签退地点

clock_end_lat: [float] 签退纬度

clock_end_lng: [float] 签退纬度

reward_time: [float] 时长

2.2.10 星级榜样信息【3.0新增】

{
    "id": 1,
    "name": "张三",
    "avatars": "http://alpha.api.volunteer.tmallwo.com/images/1.jpg",
    "political_affiliation": "党员",
    "workplace": "北京",
    "abstracts": "简介",
    "description": "描述"
}

id: [integer] ID

name: [string] 姓名

avatars: [string] 头像

political_affiliation: [string] 政治面貌

workplace: [string] 工作单位

abstracts: [string] 简介

description: [string] 详情

2.2.11 保险信息【3.0新增】

{
    "id": 1,
    "price": "100.00",
    "name": "保险",
    "photo": "http://image.com",
    "company": "中国保险",
    "description": "描述",
    "detail_link": "http://baidu.com"
}

id: [integer] ID

name: [string] 保险名称

price: [string] 价格

photo: [string] 图片

company: [string] 机构

description: [string] 简介

detail_link: [string] 详情链接

2.2.12 认领项目信息【3.0新增】

{
    "id": 1,
    "team_name": "青岛志愿者1对",
    "logo": "http://alpha.api.volunteer.tmallwo.com/images/11.jpg",
    "name": "活动那个名称 ",
    "address": "地址",
    "begin": "2017-12-25 11:08:36",
    "end": "2017-12-30 11:07:32",
    "cover": "http://alpha.api.volunteer.tmallwo.com/images/2.jpg",
    "banner":["http://alpha.api.volunteer.tmallwo.com/images/uploads/2017-10/115121508466952.jpeg"],
    "publish_time": "2017-12-25 11:07:46",
    "content": "1111",
    "claim_status": 1,
    "join_status": 1,
    "claim_list":[@认领信息],
}

id: [integer] 活动ID

team_name: [string] 团队名

logo: [string] 团队logo

name: [array] 项目名称

address: [string] 地址

begin: [string] 开始认领时间

end: [string] 结束时间

cover: [string] 活动列表图

banner: [array] 活动banner图

publish_time: [string] 发布时间

content: [string] 内容

claim_status: [integer] 认领项目状态 1未开始 2认领中 3已结束

join_status: [integer] 用户是否认领 1已认领 0未认领详情页下发

claim_list: [array] 认领的列表 @认领信息详情页下发

2.2.13 认领信息【3.0新增】

{
    id: 123,
    team_name: '程序员慰问团',
    created_at: '2013-03-03 12:12:12',
}

id: [integer] ID

team_name: [string] 团队名称

created_at: [string] 认领时间

2.2.14 星币获取|支付详情【3.0新增】

{
    "id": 1,
    "score": "10",
    "remark": "注册奖励",
    "created_at": "2017-12-15 17:04:50"
}

id: [integer] ID

score: [integer] 团队名称

remark: [string] 原由

created_at: [string] 时间

2.2.15 机构自定义信息【3.0新增】

注：此字段会再渲染页面时，在window.orgInfo里

org_info: [string] 平台介绍富文本

org_manual: [string] 使用帮助富文本

org_service: [string] 客服中心富文本

org_service_tel: [string] 客服电话

org_service_guide: [string] 引导用户修改密码富文本

real_name_register: [int] 是否要求实名注册

2.2.16 社区话题信息【3.0新增】

{
    "id": 1,
    "type": 1,
    "content": "这次志愿者活动",
    "photo": ['imageurl'],
    "like_count": 1,
    "comment_count": 1,
    "created_at": "5分钟前",
    "user_info": {},//用户信息
    "project_info": @项目想,
    "team_info": @团队信息,
    "like_list": [@用户信息],
    "comment_list": [@社区话题评论信息],
    "is_like":1
}

id: [integer] ID

type: [integer] 类型 type=1，2，3 分别表示不关联、关联项目关联团队

content: [string] 心情

photo: [array] 图片

like_count: [integer] 点赞总数

comment_count: [integer] 评论总数

created_at: [string] 发布时间

user_info: [object] 发布人

project_info: [object] 项目信息如type=2 有此字段

team_info: [object] 团队信息如type=3 有此字段

like_list: [array] 点赞用户信息

comment_list: [array] 评论信息

is_like: [integer] 是否已点赞如登陆且点赞则为1，否则为0

2.2.17 社区话题评论信息【3.0新增】

{
    "id": 1,
    "comment": "挺好的",
    "created_at": "2017-12-15 17:04:50",
    "feeling_id": 11,
    "is_display": 1,
    "feeling_is_display": 1,
    "user_info": {},//用户信息
    "comment_to": {},//用户信息
    "is_new":1
}

id: [integer] ID

comment: [string] 评论内容

created_at: [string] 评论时间

feeling_id: [integer] 被评论的话题id

is_display: [integer] 是否显示 1显示 0不显示（已删除）

feeling_is_display: [integer] 话题是否显示 1显示 0不显示（已删除）

user_info: [object] 评论的用户信息（仅有头像和昵称）

comment_to: [object] 被评论的用户信息（仅有头像和昵称），仅回复别人时才有

is_new: [integer] 是否为新消息，1为新消息

2.2.18 机构信息【5.0新增】

{
    "id": 1,
    "open_custom_config": 0,
    "custom_config": {},
    "open_stars": 0,
    "open_volunteer_certificate": 0,
}

id: [integer] 机构id

open_custom_config: [integer] 是否开启志愿者信息完善功能 0关闭 1开启废弃沿用原有的real_name_register

custom_config: [text] json格式，详见2.2.19

open_stars: [integer] 是否开启星级

open_volunteer_certificate: [integer] 是否开启志愿者证书功能 0不开启 1开启

2.2.19 志愿者自定义信息配置【5.0新增】

{
    "open_real_name": 0,
    "open_avatars": 0,
    "open_id_number": 0,
    "open_nation": 0,
    "open_addr": 0,
    "extends":[
        {
            "key": "字段名",
            "label":"职业",
            "type":1,
            "options":"老师,医生,律师",
            "is_required" 1,
        },
        {
            "key": "字段名",
            "label":"职业",
            "type":1,
            "options":"老师,医生,律师",
            "is_required" 1,
        },
    ],
}

open_real_name: [integer] 是否开启姓名 0不开启 1开启

open_avatars: [integer] 是否开启头像 0不开启 1开启

open_id_number: [integer] 是否开启身份证 0不开启 1开启

open_nation: [integer] 是否开启名族 0不开启 1开启

open_addr: [integer] 是否开启地址验证 0不开启 1开启
以上五个字断oost传参同3.1.5接口

extends: [array] 扩展字断,字段含义如下

key: [string] 字段名，用作上传时的参数名

label: [string] 展示名称

type: [string] 类型 1单项选择 select， 2多项选择 3单行输入 4多行输入 5上传图片 6日期空间 7日期时间空间

options: [string] 仅当type=1，2时有用，用英文逗号分割

is_required: [integer] 是否比输 0非必输 1必输

以上参数在传参时，请用数组上传,数组的键使用key的值，eg: <input type="text" name="extends[职业]" />

2.2.20 项目自定义信息配置【5.0新增】

[
        {
            "key": "字段名",
            "label":"职业",
            "type":1,
            "options":"老师,医生,律师",
            "is_required" 1,
        },
        {
            "key": "字段名",
            "label":"职业",
            "type":1,
            "options":"老师,医生,律师",
            "is_required" 1,
        },
]

extends: [array] 扩展字断,字段含义如下

key: [string] 字段名，用作上传时的参数名

label: [string] 展示名称

type: [string] 类型 1单项选择 select， 2多项选择 3单行输入 4多行输入 5上传图片 6日期空间 7日期时间空间

options: [string] 仅当type=1，2时有用，用英文逗号分割

is_required: [integer] 是否比输 0非必输 1必输

以上参数在传参时，请用数组上传,数组的键使用key的值，eg: <input type="text" name="extends[职业]" />

2.2.21 项目自定义支付信息配置【5.0新增】

[
        {
            "key": "字段名",
            "amount":100.00,
            "label":"T恤",
            "is_required" 1,
        },
]

payment: [array] 扩展字断,字段含义如下

key: [string] 字段名，用作上传时的参数名

amount: [float] 单价

label: [string] 商品名称

is_required: [integer] 是否比输 0非必买 1必买

以上参数在传参时，请用数组上传,数组的键使用key的值，val请传用户购买数量，eg: <input type="text" name="payment[字段名]" />

2.2.22 新闻公告

{
    id: 1,
    title: '活动',
    photo: 'http://oss-static-resource.oss-cn-beijing.aliyuncs.com/image/2017-03-09/35ca97afe5194f27eaf15a9cac6ef279.jpeg',
    content: "<div>富文本</div>"
    publish_time: "2017-02-17 13:00:00",
}

id: [int] ID

title: [string] title

photo: [string] logo图片

content: [string] 富文本内容

publish_time: [string] 发布时间

2.2.23 积分商品信息

{
  "id": 1,
  "org_info": [@机构信息],
  "team_id": [@团队信息],
  "g_name": "水杯",
  "sponsor":"星巴克",
  "thumbnail": "/uploads/2017-09/246251506503134.png",
  "g_img": "/uploads/2017-09/246251506503134.png",
  "content": "超级好用",
  "access": "包你满意",
  "type": 0,
  "price": "180.00",
  "points": 180,
  "g_num": 10,
  "u_num": 1,
  "start_time": "2017-09-27",
  "end_time": "2017-09-27",
  "created_at": "2017-09-27 17:07:08",
  "updated_at": "2017-09-27 17:07:08",
  "auto_time": "2017-09-27 17:07:08",
  "examine": 0,
  "is_display": 1,
  "condition":"女士,vip"
}

id: [integer] 商品ID

org_info: [object] 关联的机构信息

team_info: [object] 关联的团队信息

g_name: [string] 商品名称

sponsor: [string] 供应商

thumbnail: [string] 小图

g_img: [string] 大图

content: [text] 商品描述

access: [string] 购买成功描述

type: [integer] 商品类型

price: [decimal] 市场价值

points: [integer] 消耗积分

g_num: [integer] 库存

u_num: [integer] 限制购买数量

created_at: [date] 开始时间

updated_at: [date] 结束时间

auto_time: [datetime] 自动下架时间

examine: [integer] 是否审核 0开启审核 1关闭审核

is_display: [integer] 上下架 0上架 1下架

condition: [string] 限制购买标签英文,分割

2.2.24 积分商品订单信息

{
  "id": 1,
  "order_num":"aaaaaa111111",
  "org_id": 1,
  "team_id": 0,
  "goods_info": [@商品信息],
  "user_id":1,
  "status": 0,
  "num": 1,
  "points": 180,
  "collect_time":"2017-09-27 17:07:08",
  "created_at": "2017-09-27 17:07:08",
  "updated_at": "2017-09-27 17:07:08",
  "state":0,
  "reason":""
｝

id: [integer] 订单ID

order_num: [string] 订单编号

org_id: [integer] 关联的机构 id

team_id: [integer] 关联的团队 id

goods_info: [object] 关联的商品信息

user_id: [integer] 关联的用户 id

status: [integer] 审核状态 0通过 1已拒绝 2待审核

num: [integer] 购买时数量

points: [integer] 购买时消费积分

collect_time: [datetime] 领取时间

state: [integer] 领取状态 0未领取 1已领取

reason: [string] 拒绝理由

2.2.25 机构信息【7.0修改】

{
    name: '活动',
    logo: 'http://oss-static-resource.oss-cn-beijing.aliyuncs.com/image/2017-03-09/35ca97afe5194f27eaf15a9cac6ef279.jpeg',
    href: "http://wxxxx"
    project: 12,
    reward_time:133
    org_info:'机构介绍'
}

name: [string] 机构名称

logo: [string] logo

href: [string] 机构的首页地址

project_count: [string] 项目总数

reward_time: [string] 累计时长

org_info: [string] 机构介绍

2.2.26 成就信息【7.0新增】

{
    achieve_key: 'key_name',
    name: '成就名称',
    icons: ['http://oss-static-resource.oss-cn-beijing.aliyuncs.com/image/2017-03-09/35ca97afe5194f27eaf15a9cac6ef279.jpeg',]
    optional: 1
}

achieve_key: [string] 成就标识

name: [string] 成就名称

icons: [array] 成就图

optional: [integer] 是否开启等级

2.2.27 用户成长等级【7.0新增】

{
    "level": 0,
    "name":'爱心新秀',  #等级名称
    "growth": 0, #超过此成长值获得该等级
}

level: [integer] 等级

name: [string] 等级名称

growth: [integer] 最低成长值

2.2.28 签到班次信息【7.0新增】

{
    "id": 23,
    "begin": "2017-11-12 20:00:00",
    "end": "2017-11-13 00:00:00",
    "reward_time": "0.50",
    "type": 1,
    "province_id": 0,
    "province_name": "",
    "city_id": 0,
    "city_name": "",
    "county_id": 0,
    "county_name": "",
    "lat": 0,
    "lng": 0,
    "distance": 0,
    "status": 0,
}

id: [integer] 班次id

begin: [string] 开始打卡or签到时间要求

end: [integer] 结束打卡or签退的时间

reward_time: [string] 奖励时长

type: [integer] 类型，type=1为打卡类型，type=2为签到类型

province_id: [integer] 省份id

province_name: [string] 省份名称

city_id: [integer] 城市id

city_name: [string] 城市名称

county_id: [integer] 区县id

county_name: [string] 区县名称

lat: [float] 打卡坐标的纬度

lng: [float] 打卡坐标的经度

distance: [float] 距离

status: [integer] 用户在该打卡的状态，待签到 => 0，待签退 => 1，未签到 => 2，未签退 => 3，已打卡 => 4，审核中 => 5，已通过 => 6，被驳回 => 7

2.2.29 求助信息(新增)

{
    "id": 1,
    "name": 发布人,
    "phone": 电话,
    "category": 类别,
    "title": 标题,
    "content": 详情,
    "village": 乡镇,
    "addr": 详细地点,
    "team_id": 1,
    "team_name": 关联的团队名字,
    "project_id": 1,
    "project_name": 关联的项目名字,
    "status": 2,
}

id int(11) NOT NULL,

name varchar(64) NOT NULL,

phone varchar(255) NOT NULL COMMENT '手机号',

category varchar(11) NOT NULL COMMENT '类别',

title varchar(64) NOT NULL COMMENT '标题',

content text(0) NOT NULL COMMENT '详情',

village varchar(11) NOT NULL COMMENT '乡镇',

addr varchar(64) NOT NULL COMMENT '详细地点',

team_id int(11) COMMENT '关联的团队id',

team_name varchar(64) COMMENT '关联的团队名字',

project_id int(11) COMMENT '关联的项目id',

project_name varchar(64) COMMENT '关联的项目名字',

status int(2) COMMENT '需求状态 0：待审核 1：服务中 2：已完成 3：已拒绝',

created_at timestamp(0),

updated_at timestamp(0),

2.2.30 基地信息

"id"            : 基地id , 
"name"          : 基地名称 , 
"address"       : 地址 ,     
"contacts"      : 联系人 ,    
"phone"         : 手机号 ,
"base_url"      : 图片地址 （相对路径） ,
"desc"          : 详情 说明 ,          
"base_state"    : 上下架状态 0下架 1上架 ,  
"status"        : 启用（删除）状态 0禁用 1启用 ,

id int(11) NOT NULL,

name varchar(64) NOT NULL,

phone char(13) NOT NULL COMMENT '手机号',

contacts varchar(64) NOT NULL COMMENT '联系人',

address varchar(255) NOT NULL COMMENT '地址',

desc text(0) NOT NULL COMMENT '详情',

base_url varchar(255) NOT NULL COMMENT '图片url',

base_state int(11) NOT NULL COMMENT '上下架状态 0下架 1上架',

status int(11) COMMENT '删除状态',

created_at timestamp(0),

updated_at timestamp(0),

2.2.30 基地分类信息

"id"            : 基地分类id , 
"name"          : 基地分类名称 , 
"status"        : 启用（删除）状态 0禁用 1启用 ,

id int(11) NOT NULL,

name varchar(64) NOT NULL,

status int(11) COMMENT '禁用（删除）状态 0禁用 1启用',

created_at timestamp(0),

updated_at timestamp(0),

3、接口列表

3.1 用户类接口

3.1.1 注册接口 [4.0修改]

请求URL

POST
/register

请求参数

username: [string] 用户名【非必填】实名注册时非必填

photo: [string] 手机号码【必填】

verify_code: [string] 验证码【必填】

pwd: [string] 密码【必填】

avatars: [string] 头像【非必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.2 登录接口 [4.0修改]

请求URL

POST
/login

请求参数

username: [string] 用户名 or 手机号 or 身份证号码【必填】

pwd: [string] 密码【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.3 获取个人信息接口

请求URL

get
/user

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.4 完善个人信息接口【7.0修改，个人信息接口中有have_pwd字断】

请求URL

POST
/user

请求参数

avatars: [url] 头像【非必填】

good_at: [array] 个人擅长文本【非必填】

slogan: [string] 口号【非必填】

pwd: [string] 密码【have_pwd = 0 时必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.5 实名认证接口 [5.0修改]

请求URL

POST
/user/check

请求参数

avatars: [url] 头像【非必填】

real_name: [string] 真实姓名【必填】

num_type: [int] 证件类型【必填】1内地 2香港 3澳门 4台湾 5护照

id_number: [string] 身份证号会校验此字段，根据字段生产性别、生日【必填】

nation: [string] 民族【必填】

province_id: [integer] 省份id 【必填】

city_id: [integer] 城市id 【必填】

county_id: [integer] 区县id 【必填】

addr: [string] 详细地址【必填】

extends[*]: [string] 用户自定义字段 *号表示自定义字段的label，详见2.1.19

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.5.1 修改个人资料接口 [5.0修改]

请求URL

POST
/check/edit

请求参数

nation: [string] 民族

birthday: [string] 出生日期【用户身份证非18位可修改】

sex: [integer] 性别【用户身份证非18位可修改】

province_id: [integer] 省份id

city_id: [integer] 城市id

county_id: [integer] 区县id

addr: [string] 详细地址

extends[*]: [string] 用户自定义字段 *号表示自定义字段的label，详见2.1.19

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.6 修改密码和找回密码接口

注：使用3.1.21接口发送短信

请求URL

POST
/reset/pwd

请求参数

phone: [string] 手机号码【必填】

verify_code: [string] 验证码【必填】

pwd: [string] 密码【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.7 收藏【项目|团队】接口

请求URL

POST
/user/collection

请求参数

type: [integer] 0项目 1团队【必填】

id: [integer] 收藏的id【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.1.8 删除收藏【项目|团队】接口

请求URL

post
/user/uncollection

请求参数

type: [integer] 0项目 1团队【必填】

id: [integer] 收藏的id【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.1.9 收藏【项目|团队】列表接口

请求URL

get
/user/collection

请求参数

type: [integer] 0项目 1团队【必填】

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @项目信息 or @团队信息
        ]
    },
    "error_message": ""
}

3.1.10 我加入的团队列表接口

请求URL

get
/user/team

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @团队信息
        ]
    },
    "error_message": ""
}

3.1.11 我加入的项目接口

请求URL

get
/user/project

请求参数

status: [intger] 1待录用 2已录用 3已结束【非必填】

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @团队信息
        ]
    },
    "error_message": ""
}

3.1.12 我志愿时长接口

请求URL

get
/user/reward/time

响应

{
    "error_code": 0,
    "data":{
        "reward_time": 13.5,
        "join_project_count": 13,
        "project":[
            @项目信息
        ]
    },
    "error_message": ""
}

3.1.13 补录时长申请列表接口

请求URL

get
/user/apply

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @时长申请信息
        ]
    },
    "error_message": ""
}

3.1.14 补录时长申请接口

请求URL

post
/user/apply

请求参数

project_id: [integer] 项目id 【必填】

reward_time: [float] 补录时长【必填】

content: [string] 申请内容【必填】

attachment: [array] 申请附件【非必填】

响应

{
    "error_code": 0,
    "data":{
        @时长申请信息
    },
    "error_message": ""
}

3.1.15 补录时长项目列表接口

注：报名且被录用的项目
请求URL

get
/project/apply

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @项目信息
        ]
    },
    "error_message": ""
}

3.1.16 家庭成员列表接口

注:家庭成员数和家庭总时长请求此接口获取

请求URL

get
/myfamily

响应

{
    "error_code": 0,
    "data":{
        "family_size": 10,
        "reward_time": 25.9,
        "family":[
            @用户信息
        ]
    },
    "error_message": ""
}

3.1.17 添加家庭成员接口【4.0修改】

请求URL

post
/myfamily

请求参数

real_name: [string] 真实姓名【必填】

id_number: [string] 身份证号会校验此字段，根据字段生产性别、生日【必填】

nation: [string] 民族【必填】

province_id: [integer] 省份id 【必填】

city_id: [integer] 城市id 【必填】

county_id: [integer] 区县id 【必填】

addr: [string] 详细地址【必填】

pwd: [string] 密码【必填】

relation: [string] 关系【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.18 家庭成员信息接口

请求URL

get
/myfamily/{id}

请求参数

id: [integer] 用户id，家庭用户列表接口中的id【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.19 我的消息接口

请求URL

get
/message

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @消息信息
        ],
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

3.1.20 打卡接口【3.0修改】

请求URL

post
/clock/in

请求参数

code: [string] 二维码的字符串 or 口令【必填】

type: [integer] 打卡类型 1二维码打卡 2口令打卡【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.1.21 打卡记录接口

请求URL

get
/clock/in

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @打卡信息   //已完成的打卡记录
        ],
        "next":  //下次打卡信息提示
        {
            "begin":"2017-10-11 11:11:11",
            "end":"2017-10-11 11:11:11",
            "reward_time": 2.0,
            "project":@项目信息
        }
    },
    "error_message": ""
}

3.1.22 个人中心首页接口

请求URL

get
/user/center

响应

{
    "error_code": 0,
    "data":{
        "user":@用户信息,
        "team_count": 1, //团队总数
        "project_count": 3, //项目总数
        "msg_count": 0, //未读消息数
        "comment_count": 1,//未读社区评论数
    },
    "error_message": ""
}

3.1.23 发送短信接口（无图片验证码）

请求URL

POST
/phone/verifycode

请求参数

phone: phone【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.1.24 退出登录接口 [退出请务必调用此接口]

请求URL

get
/logout

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.1.25 删除家庭成员接口

请求URL

delete
/myfamily/{id}

请求参数

id: [integer] 用户id，家庭用户列表接口中的id【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.26 微信素材下载

请求URL

get
/weixin/media

请求参数

media_id: [string] 素材id【必填】

响应

{
    "error_code": 0,
    "data":{
        'url':'http://img.jpg',
    },
    "error_message": ""
}

3.1.27 绑定家庭成员接口【4.0新增】

请求URL

post
/myfamily/bind

请求参数

phone: [string] 手机号【必填】

pwd: [string] 密码【必填】˚did

relation: [string] 关系【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.28 修改绑定家庭成员信息接口【4.0新增】

请求URL

put
/myfamily/{id}

请求参数

id: [integer] 用户id，家庭用户列表接口中的id 【必填】

pwd: [string] 密码【非必填】

relation: [string] 关系【非必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.1.29 手机号注册登陆接口【5.0新增】

请求URL

post
/login/phone

请求参数

photo: [string] 手机号码【必填】

verify_code: [string] 验证码【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

3.2 运营类接口

请求URL

get
/banner

响应

{
    "error_code": 0,
    "data":{
        list:[
            @Banner信息
        ]
    },
    "error_message": ""
}

3.3 志愿项目类接口

3.3.1 首页接口

请求URL

get
/index

响应

{
    "error_code": 0,
    "data":{
        "banner"[
            @Banner信息
        ],
        "project":[
            @项目信息
        ],
        "news":[
            @新闻信息
        ],
    },
    "error_message": ""
}

3.3.2 项目列表接口

请求URL

get
/project

请求参数

name: 项目名称，模糊匹配【非必填】

team_id: 项目id【非必填】

service_object: 服务对象【非必填】

service_category: 服务类别【非必填】

sort: 排序规则【非必填】默认按发布时间 [distance|time|recommend]

recommend: 【非必填】是否推荐

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @项目信息
        ]
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

3.3.3 项目详情

请求URL

get
/project/{id}

请求参数

id: 项目id【必填】

preview: 预览项目，无视项目是否上线【非必填】请传1

响应

{
    "error_code": 0,
    "data":{
            @项目信息
    },
    "error_message": ""
}

3.3.4 加入/退出项目【7.0修改】

如需要支付，会返回特殊的结构，微信公众号支付返回payConfig字断;H5支付返回wechatPayUrl,收到url直接跳转到该url即可唤起支付

请求URLhttp://wx8b7f9e8dc8e839cb.wechat.alpha.flashdiet.cn/

post
/project/join/{id}

请求参数

id: 项目id【必填】

type: 类型0退出 1加入【必填】

extends[*]: [string] 用户自定义字段 *号表示自定义字段的label，详见2.1.20，【非必填】

payment[*]: [string] 项目自定义支付 *号表示自定义字段的name，值取商品数量，详见2.1.21
响应【非必填】

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.3.5 加入项目用户列表

请求URL

get
/project/user/{id}

请求参数

id: 项目id【必填】

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @用户信息
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

3.4 团队类接口

3.4.1 团队列表接口【3.0修改】

请求URL

get
/team

请求参数

team_type: 团队类别【非必填】

service_category: 服务类别【非必填】

service_object: 服务对象【非必填】

county_id: 区域id【非必填】

name: 团队名称，模糊匹配【非必填】

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @团队信息
        ]
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

3.3.6 项目支付结果【7.0新增】

请求URL

post
/project/pay/result/{sn}

请求参数

sn: payment返回的支付交易号【必填】

{
    "error_code": 0,
    "data":{
        "code": 0, //0失败 1成功
        "desc": "待支付",
        "project_id": "72" //项目id
    },
    "error_message": ""
}

3.4.2 团队详情

请求URL

get
/team/{id}

请求参数

id: 项目id【必填】

响应

{
    "error_code": 0,
    "data":{
            @团队信息
    },
    "error_message": ""
}

3.4.3 加入/退出团队

请求URL

post
/team/join/{id}

请求参数

id: 项目id【必填】

type: 类型0退出 1加入【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

3.4.4 团队项目列表

详见3.3.2

4、攻略接口列表

4.1 攻略接口

攻略复用紫鹿的代码，文档详见：
https://www.zybuluo.com/lina/note/677843

调用过程中，将接口的host替换为志多星即可：
api.guide.volunteerzhiduoxing.com

攻略后台地址：admin.guide.volunteerzhiduoxing.com
攻略前台地址：m.guide.volunteerzhiduoxing.com

5、志多星3.0接口

5.1 星级榜样列表接口

请求URL

get
/goodexample

请求参数

响应

{
    "error_code": 0,
    "data":{
        "list":[@星级榜样信息]
    },
    "error_message": ""
}

5.2 星级榜样详情接口

请求URL

get
/goodexample/{id}

请求参数

id: id【必填】

响应

{
    "error_code": 0,
    "data":{
        @星级榜样信息
    },
    "error_message": ""
}

5.3 保险列表接口

请求URL

get
/insurance

请求参数

响应

{
    "error_code": 0,
    "data":{
        "list":[@保险信息],
        "banner":[@Banner信息],
    },
    "error_message": ""
}

5.4 保险详情接口

请求URL

get
/insurance/{id}

请求参数

id: id【必填】

响应

{
    "error_code": 0,
    "data":{
        @保险信息
    },
    "error_message": ""
}

5.5 认领项目列表接口

请求URL

get
/claim

请求参数

name: 项目名称，模糊匹配【非必填】

team_id: 项目id【非必填】

service_object: 服务对象【非必填】

service_category: 服务类别【非必填】

sort: 排序规则【非必填】默认按发布时间 [distance|time|recommend]

recommend: 【非必填】是否推荐

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @认领项目信息
        ]
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

5.6 认领项目详情接口

请求URL

get
/claim/{id}

请求参数

id: 认领项目id【必填】

响应

{
    "error_code": 0,
    "data":{
            @认领项目信息
    },
    "error_message": ""
}

5.7 认领项目接口

请求URL

post
/claim/{id}

请求参数

id: 认领项目id【必填】

team_name: 团队名称【必填】

contact_name: 联系人【必填】

contact_phone: 联系人手机【必填】

contact_email: 联系人邮箱【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

5.8 星币明细接口

请求URL

get
/user/score/{type}

请求参数

type: 类型 0收入 1支出【必填】

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @星币获取|支付详情
        ]
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

5.9 修改手机号接口

请求URL

POST
/user/phone

请求参数

phone: [string] 手机号码【必填】

verify_code: [string] 验证码【必填】

响应

{
    "error_code": 0,
    "data":{
        @用户信息
    },
    "error_message": ""
}

6、志多星社区接口

6.1 话题列表接口

请求URL

get
/feeling

请求参数

type: 类型【非必填】不填表示全部， 1无标签 2项目 3团队

relation_id: 关联id【非必填】当type=2|3必填，分别表示项目id或团队id

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @社区话题信息
        ],
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

6.2 发布话题接口

请求URL

post
/feeling

请求参数

type: 类型【必填】不填表示全部， 1无标签 2项目 3团队

relation_id: 关联id【非必填】当type=2|3必填，分别表示项目id或团队id

content: 内容【必填】

photo: 图片【非必填】

响应

{
    "error_code": 0,
    "data":{
        @社区话题信息
    },
    "error_message": ""
}

6.3 删除话题接口

请求URL

delete
/feeling/{id}

请求参数

id: 话题id 【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.4 我的话题列表接口

请求URL

get
/feeling/my

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "new_comment": 10,//新消息数
        "list":[
            @社区话题信息
        ],
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

6.5 点赞话题接口

请求URL

get
/feeling/like/{id}

请求参数

id: 话题id 【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.6 取赞话题接口

请求URL

get
/feeling/dislike/{id}

请求参数

id: 话题id 【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.7 发布话题评论接口

请求URL

post
/feeling/comment/{id}

请求参数

id: 话题id 【必填】

comment: 内容【必填】

parent_id: 如是回复评论，传被评论的内容id【非必填】

响应

{
    "error_code": 0,
    "data":{
        @社区话题评论信息
    },
    "error_message": ""
}

6.8 删除话题评论接口

请求URL

delete
/comment/{id}

请求参数

id: 话题id 【必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

6.9 我的话题评论消息接口

请求URL

get
/comment/new

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认20

响应

{
    "error_code": 0,
    "data":{
        [
            @社区话题评论信息
        ]
    },
    "error_message": ""
}

6.10 话题列表接口

请求URL

get
/feeling/{id}

请求参数

id: i 【必填】

响应

{
    "error_code": 0,
    "data":{
        @社区话题信息
    },
    "error_message": ""
}

7、志多星社区接口

7.1 公告接口

7.1.1 公告列表接口

请求URL

GET
/news/list

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    error_code: 0,
    data: {
        "list":[
            @新闻信息 
        ]
         "page":{
            @分页字段
        }
    }
}

7.1.2 公告详情接口

请求URL

GET
/news/{id}

请求参数

id: id【必填】

响应

{
    error_code: 0,
    data: {
        @新闻信息
    }
}

8、积分商城接口

请求URL

get
/banner/{type}

请求参数

type: 类型【必填】商品banner 0

响应

{
    "error_code": 0,
    "data":{
        list:[
            @Banner信息
        ]
    },
    "error_message": ""
}

8.2 商品接口

8.2.1 商品列表接口

请求URL

GET
/goods/list

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data": {
        "list":[
            @积分商品信息 
        ]
         "page":{
            @分页字段
        }
    }
    "error_message": ""
}

8.2.2 商品详情接口

请求URL

GET
/goods/${id}

请求参数

id: 商品id【必填】

响应

{
    "error_code": 0,
    "data": {
        @商品信息
    },
    "error_message": ""
}

8.2.3 立即兑换接口

请求URL

GET
/goods/change/{id}

请求参数

id: 商品id 【必填】

响应

{
    "error_code": 0,
    "data": {
        @订单信息
    },
    "error_message": ""
}

8.2.4 兑换记录接口

请求URL

GET
/order/myorders

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data": {
        "list":[
            @订单信息
        ]
         "page":{
            @分页字段
        }
    }
    "error_message": ""
}

8.2.5 确认兑换接口

请求URL

GET
/order/collect/{id}

请求参数

id: 订单id 【必填】

响应

{
    "error_code": 0,
    "error_message": ""
}

9、平台相关接口

9.1 首页接口

请求URL

get
/platform/index

响应

{
    "error_code": 0,
    "data":{
        "banner"[
            @Banner信息
        ],
        "project":[
            @项目信息
        ],
        "news":[
            @新闻信息
        ],
    },
    "error_message": ""
}

9.2 项目列表搜索接口

请求URL

get
/platform/project

请求参数

name: 项目名称，模糊匹配【非必填】

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @项目信息
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

9.3 机构搜索接口

请求URL

get
/platform/org

请求参数

name: 机构名称，模糊匹配【非必填】

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @机构信息
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

9.4 志愿者搜索接口

请求URL

get
/platform/volunteer

请求参数

id_number: 身份证【必填】

响应

{
    "error_code": 0,
    "data":{
        "volunteer_info":@志愿者信息,
        "org_count": 2, //加入机构数
        "team_count": 2, //加入团队数
        "project_count": 3, //参加项目数
        "reward_time": "8.00", //累计时长
        "project_list":[ //用户参加的所有项目
            {
                "org":@机构信息,//项目所在的机构
                "project":@项目信息,//项目信息
                "reward_time": 13,//奖励时长
            }
        ]
    },
    "error_message": ""
}

9.5 团队列表搜索接口

请求URL

get
/platform/team

请求参数

team_type: 团队类别【非必填】

service_category: 服务类别【非必填】

service_object: 服务对象【非必填】

county_id: 区域id【非必填】

name: 团队名称，模糊匹配【非必填】

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @团队信息
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

9.6 认领项目列表接口

请求URL

get
/platform/claim

请求参数

name: 项目名称，模糊匹配【非必填】

team_id: 项目id【非必填】

service_object: 服务对象【非必填】

service_category: 服务类别【非必填】

sort: 排序规则【非必填】默认按发布时间 [distance|time|recommend]

recommend: 【非必填】是否推荐

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @认领项目信息
        ]
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

9.7 公告列表接口

请求URL

GET
/platform/news

请求参数

current_page: 页码【非必填】默认1

page_size: 页长【非必填】默认10

响应

{
    error_code: 0,
    data: {
        "list":[
            @新闻信息 
        ]
         "page":{
            @分页字段
        }
    }
}

10、V7.0接口

10.1 当前机构信息接口

请求URL

get
/org/info

响应

{
    "error_code": 0,
    "data":{
        @机构信息
    },
    "error_message": ""
}

10.2 获取星币、成长值获取和用户等级的配置信息

请求URL

get
/growth/config

响应

{
    "error_code": 0,
    "data":{
        "score":[
            {
                "label":'每日登陆',
                "value": 13,
            },
            {
                "label":'实名认证',
                "value": 13,
            },
        ],
        "growth_value":[
            {
                "label":'每日登陆',
                "value": 13,
            },
            {
                "label":'实名认证',
                "value": 13,
            },
        ],
        "growth_level":[
            {
                "level": 0,
                "name":'爱心新秀',  #等级名称
                "growth": 0, #超过此成长值获得该等级
            },
            {
                "level": 1,
                "name":'爱心见习生',
                "growth": 100,
            },
        ],
    },
    "error_message": ""
}

10.3 获取用户志愿成就

注：此接口返回用户未获取的成就

请求URL

get
/achieve

响应

{
    "error_code": 0,
    "data":{
        "list":[
            {
                achieve_key: 'key_name', #成就标识
                name: '成就名称',#成就名称
                icons:'http://oss-static-resource.oss-cn-beijing.aliyuncs.com/image/2017-03-09/35ca97afe5194f27eaf15a9cac6ef279.jpeg', #成就icon
                level:1 #等级
            }
        ]
    },
    "error_message": ""
}

10.4 获取用户志愿成就

注：此接口返回用户已获取的成就

请求URL

get
/user/achievement/

响应

{
    "error_code": 0,
    "data":{
        "list":[
            {
                achieve_key: 'key_name', #成就标识
                name: '成就名称',#成就名称
                icons:'http://oss-static-resource.oss-cn-beijing.aliyuncs.com/image/2017-03-09/35ca97afe5194f27eaf15a9cac6ef279.jpeg', #成就icon
                level:1 #等级
            }
        ]
    },
    "error_message": ""
}

10.5 获取用户某个成就信息

请求URL

get
/user/achievement/{key}

请求参数

key: 成就key【必填】

响应

{
    "error_code": 0,
    "data":{
        "achievement_info":@成就信息
        "level":1,#当前等级
        "tips":'志愿时长达到101小时，快去晒成就吧!',
    },
    "error_message": ""
}

10.6 分享用户某个成就信息

请求URL

get
/user/achievement/{key}/share

请求参数

key: 成就key【必填】

响应

{
    "error_code": 0,
    "data":{
        "key": 'key_name', #成就标识
        "label": '成就名称',#成就名称
        "logo":'http://oss-static-resource.oss-cn-beijing.aliyuncs.com/image/2017-03-09/35ca97afe5194f27eaf15a9cac6ef279.jpeg', #成就icon
        "level":1 #等级
        "tips":'志愿时长超过101小时,超过了机构名称97%的志愿者',
        "user_info":@用户信息
    },
    "error_message": ""
}

10.7 获取用户等级信息

请求URL

get
/user/level

响应

{
    "error_code": 0,
    "data":{
        "growth_level_now":@用户成长等级, #当前用户等级
        "growth_level_next":@用户成长等级, #用户的下一级 如为满级，不下发此字断
    },
    "error_message": ""
}

10.8 分享回调

请求URL

get
/share/callback/{type}

请求参数

type: 分享那些【必填】待确定

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

11、新版打卡签到接口

本类别的接口的url前缀请用v2，不要使用v1

11.1 获取可打卡项目接口

此接口项目信息中包含nearest_clock_in字断，该字断是这个项目最近的一次可打卡的班次信息

请求URL

get
/user/project/clock

请求参数

无

响应

{
    "error_code": 0,
    "data":{
        "three_day_project":[@项目详情],
        "project":[@项目详情]
    },
    "error_message": ""
}

11.2 获取项目打卡班次列表接口

请求URL

get
/project/{project_id}/clock

请求参数

project_id: 项目id 【必填】

响应

{
    "error_code": 0,
    "data":{
        "three_day_clock":[@签到班次信息],//最近三天要签到的
        "clock":[@签到班次信息] //所有签到的
    },
    "error_message": ""
}

11.3 获取某次打置信息接口

请求URL

get
/clock/{id}/info

请求参数

id: 班次信息id 【必填】

响应

{
    "error_code": 0,
    "data":{
        "clock_info":@签到班次信息,//含状态信息
        "user_clock_info":@打卡信息 //用户的打卡信息，如何时打卡等
    },
    "error_message": ""
}

11.4 打卡签到接口

请求URL

post
/clock/{id}

请求参数

id: 班次信息id 【必填】

addr: 打卡地址【非必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

11.5 申请补卡接口

请求URL

post
/clock/{id}/apply

请求参数

id: 班次信息id 【必填】

clock_in_time: [datetime] 打卡时间 or 签到时间 2019-1-12 12:12:12 【必填】

clock_end_time: [datetime] 签退时间 2019-1-12 12:12:12 【非必填】班次信息type=2的时候必填

content: [string] 申请内容【必填】

attachment: [array] 申请附件【非必填】

响应

{
    "error_code": 0,
    "data":{
    },
    "error_message": ""
}

11.6 获取能申请补签过的项目接口

请求URL

get
/clock/apply/project

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @项目信息
        ]
    },
    "error_message": ""
}

11.7 获取项目的所能补卡的班次接口

请求URL

get
/project/{id}/clock/list

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @签到班次信息
        ]
    },
    "error_message": ""
}

11.8 获取我的申请记录接口

请求URL

get
/apply/list

响应

{
    "error_code": 0,
    "data":{
        "list":[
        ]
    },
    "error_message": ""
}

12、星巴克申请资助接口

12.1 提交申请信息接口

请求URL

post
/support/create

请求参数

user_name: 申请人姓名【必填】

user_business_province: 所属业务区域省【必填】

user_business_city: 所属业务区域市【必填】

user_store: 所属门店【必填】

user_position: 职位【必填】

user_job_num: 工号【必填】

user_phone: 联系电话【必填】

user_email: 电子邮箱【必填】

user_apply_rsason: 申请理由【必填】

user_apply_monry: 申请金额【必填】

group_name: 组织名称【必填】

group_credit_num: 统一社会信用代码【非必填】

group_addr: 组织地址【必填】

group_legal_person: 法人【必填】

group_user: 联系人【必填】

group_user_phone: 联系人电话【必填】

group_user_email: 联系人邮箱【必填】

group_service: 服务领域【必填】

group_info: 组织简介【必填】

group_certificate: 登记证书【非必填】[array]

project_name: 项目名称【必填】

project_field: 项目领域【必填】[orject]

project_start: 项目实施开始时间【必填】

project_end: 项目实施结束时间【必填】

project_addr: 项目实施地点【必填】

project_money: 项目预算【必填】

project_info: 项目描述【必填】

project_effect: 项目实施成效【必填】

project_object: 项目收益对象【必填】

project_resources: 额外提供资源【非必填】

plan: 【必填】[object]
{{activity_name: '活动名称',
activity_start: '活动开始时间',
activity_end: '活动结束时间',
activity_objective: '活动目的',
activity_people: '活动收益人数',
activity_info: '活动内容'
}}

budget: 【必填】[object]
{{budget_type: '预算类型', （见2.1.9）
budget_purpose: '预算用途',
budget_price: '单价',
budget_num: '数量',
budget_money: '金额',
}}

budget_reason: 预算理由【非必填】

响应

{
    "error_code": 0,
    "data":{
        "list":[
        ]
    },
    "error_message": ""
}

12.2 申请资助列表接口

请求URL

get
/support/list

请求参数

status: 申请资助状态【非必填】（见2.2.0）

响应

{
    "error_code": 0,
    "data":{
        "list":[
        ]
    },
    "error_message": ""
}

12.3 申请资助详情接口

请求URL

get
/support/show/{id}

请求参数

id: 申请资助id 【必填】

响应

{
    "error_code": 0,
    "data":{
        "list":[
        ]
    },
    "error_message": ""
}

12.4 修改资助申请接口

请求URL

post
/support/{id}

请求参数

id: 申请资助id 【必填】

、、、

响应

{
    "error_code": 0,
    "data":{
        "list":[
        ]
    },
    "error_message": ""
}

12.5 撤销/再次提交资助申请接口

请求URL

get
/support/{id}

请求参数

id: 申请资助id 【必填】

type: 撤销：3 再次提交：0【必填】

响应

{
    "error_code": 0,
    "data":{
        "list":[
        ]
    },
    "error_message": ""
}

13、南漳需求-求助

13.1 提交申请求助接口

请求URL

POST
/demand

请求参数

name: 申请人姓名【必填】

phone: 手机号【必填】

category: 类别【必填】

title: 标题【必填】

content: 详情【必填】

village: 乡镇【必填】

addr: 详细地点【必填】

响应

{
    "error_code": 0,
    "data":{
        @求助信息（上传的信息）
    },
    "error_message": ""
}

13.2 获取求助列表接口

请求URL

GET
/demand/all

请求参数

page: 页码【非必填】默认1

page_size: 页长【非必填】默认10】

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @求助信息
        ],
        "page":{
            @分页字段
        }
    },
    "error_message": ""
}

13.3 获取自己求助列表接口

请求URL

GET
/demand

响应

{
    "error_code": 0,
    "data":{
        [
            {@求助信息}
        ]
    },
    "error_message": ""
}

13.4获取求助详情

请求URL

GET
/demand/{id}

请求参数

id: 求助id

响应

{
    "error_code": 0,
    "data":{
        @求助信息
    },
    "error_message": ""
}

14、APP对接

X-auth-token : [string] 登录后获取的 token 信息, 请求头带此字段

X-org-code : [string] 机构表识字段,所有请求均需要此字段，测试环境用yMYerkEaOB 请求头带此字段

14.1 机构配置信息

请求URL

GET
/api/v2/conf

请求参数

响应

{
    "error_code": 0,
    "data": {
        "serviceTarget": [
            "儿童",
        ],
        "serviceCategory": [
            "文明健康",
        ],
        "teamCategory": [
            "党政机关",
        ],
        "goodAt": [
            "关爱服务",
        ],
        "orgInfo": {
            "name": "志多星演示版",
            "logo": "http://api.volzdx.cn/images/uploads/2020-02/488211582098336.png",
            "real_name_register": 1,
            "module_settings": [
                [
                    {
                        "label": "志愿项目",
                        "key": "volunteer_project",
                        "icon": "http://api.volzdx.cn/images/uploads/2018-12/362691544419728.png",
                        "settings": {
                            "label": "志愿活动",
                            "icon": "http://api.volzdx.cn/images/uploads/2018-12/362691544419728.png"
                        }
                    },
                ],
            ],
            "volunteer_feedback": 1,
            "funding_application": 0
        },
        "serviceArea": [
            {
                "value": "扶贫",
                "label": "扶贫"
            },
        ]
    },
    "error_message": ""
}

14.2 图片验证码

验证码图片为一次性的，如果输入错误则作废，需要重新获取图片内容
请求URL

GET
/api/captcha/app

请求参数

响应

{
    "error_code": 0,
    "data": {
        "sensitive": false,
        "key": "$2y$10$ZNX65xVgn1X1cLfEKBK.VuxdbbDntCrhI1HW.7W1CO2OqktO7o6vW", //验证码图片标识符
        "img": "data:image/png;base64,xxx" //图片base64编码
    },
    "error_message": ""
}

14.3 发送短信验证码

请求URL

POST
/api/app/verifycode

请求参数

key: 图片验证码接口返回的key值【必填】

captcha_code: 验证码【必填】

phone: 手机号【必填】

响应

{
    "error_code": 0,
    "data": {
    },
    "error_message": ""
}

14.4 手机号验证码快速登录

请求URL

POST
/api/v2/login/phone

请求参数

verify_code: 验证码【必填】

phone: 手机号【必填】

响应

{
    "error_code": 0,
    "data": {
        "id": 446363,
        "username": "用户_94020012",
        "email": "email@email.com",
        "phone": "15510073021",
        "avatars": "",
        "open_id": "",
        "real_name": "邱开",
        "nation": "汉族",
        "sex": 1,
        "birthday": "1987-08-03",
        "identifier": "V200628446363",
        "slogan": "文明点亮你我，志愿感动社会",
        "reward_time": "0.00",
        "id_number": "421122198708037319",
        "province_id": 0,
        "province_name": "",
        "city_id": 0,
        "city_name": "",
        "county_id": 0,
        "county_name": "",
        "township_id": 0,
        "township_name": "",
        "addr": "",
        "score": 0,
        "family_id": 0,
        "relation": "",
        "join_family_time": "",
        "extends": null,
        "stars": 0,
        "in_blacklist": 0,
        "num_type": 1,
        "achievement": 0,
        "growth": 0,
        "NO": "",
        "regitser_time": "2020-06-28 23:42:09",
        "server_time": "2020-09-10 23:23:23",
        "have_pwd": 1,
        "token": "c8482a5fc09574f49ad7537db803a99c5f5655db5cc81"
    },
    "error_message": ""
}

14.5 账号密码登录

请求URL

POST
/api/v2/login

请求参数

username: 手机号【必填】

pwd: 密码【必填】

响应

{
    "error_code": 0,
    "data": {
        "id": 446363,
        "username": "用户_94020012",
        "email": "email@email.com",
        "phone": "15510073021",
        "avatars": "",
        "open_id": "",
        "real_name": "邱开",
        "nation": "汉族",
        "sex": 1,
        "birthday": "1987-08-03",
        "identifier": "V200628446363",
        "slogan": "文明点亮你我，志愿感动社会",
        "reward_time": "0.00",
        "id_number": "421122198708037319",
        "province_id": 0,
        "province_name": "",
        "city_id": 0,
        "city_name": "",
        "county_id": 0,
        "county_name": "",
        "township_id": 0,
        "township_name": "",
        "addr": "",
        "score": 0,
        "family_id": 0,
        "relation": "",
        "join_family_time": "",
        "extends": null,
        "stars": 0,
        "in_blacklist": 0,
        "num_type": 1,
        "achievement": 0,
        "growth": 0,
        "NO": "",
        "regitser_time": "2020-06-28 23:42:09",
        "server_time": "2020-09-10 23:23:23",
        "have_pwd": 1,
        "token": "c8482a5fc09574f49ad7537db803a99c5f5655db5cc81"
    },
    "error_message": ""
}

15、实践基地

15.1 实践基地列表

请求URL

get
/practiceBase

请求参数

name: 基地名称，模糊匹配【非必填】

category_id: 基地分类id【非必填】

响应

{
    "error_code": 0,
    "data":{
        "list":[
            @基地信息
        ]
         "page":{
            @分页字段
        }
    },
    "error_message": ""
}

15.2 实践基地详情

请求URL

get
/practiceBase/{id}

请求参数

id: 基地id【必填】

响应

{
    "error_code": 0,
    "data":{
            @基地信息
    },
    "error_message": ""
}

15.3 实践基地分类列表

请求URL

get
/practiceBaseCategory

响应

{
    "error_code": 0,
    "data":[
        {
            @基地分类信息
        }
    ],
    "error_message": ""
}

志多星前端1.0 接口文档

1、项目约定

1.1 基本约定

1.1.1 API Base Url

1.1.2 鉴权字段(身份标识) 【6.0修改】

1.1.3 HTTP请求中字段要求

1.2 通用接口

1.2.1 通用接口URL

1.2.2 上传图片

1.2.3 验证码图片

1.2.4 发送短信

1.2.5 城市列表接口

1.2.6 城市下区域接口 【3.0新增】

1.3 通用响应字段

1.3.1 状态字段

1.3.2 数据字段

1.3.3 分页字段

2、数据结构

2.1 常用字段含义

2.1.1 性别字段

2.1.2 审核状态

2.1.3 黑名单状态

2.1.4 Banner跳转方式

2.1.5 积分商品是否开启审核

2.1.6 积分商品上下架

2.1.7 积分商品订单审核状态

2.1.8 积分商品是否领取

2.1.9 预算类型

2.2.0 资助申请状态

2.2.1 项目project_status状态含义

2.2 核心结构

2.2.1 用户信息 【7.0修改】

2.2.2 团队信息

2.2.3 项目信息 【5.0修改】

2.2.4 服务类型信息

2.2.5 服务对象信息

2.2.6 Banner信息

2.2.7 时长申请信息

2.2.8 消息信息

2.2.9 打卡信息

2.2.10 星级榜样信息 【3.0新增】

2.2.11 保险信息 【3.0新增】

2.2.12 认领项目信息 【3.0新增】

2.2.13 认领信息 【3.0新增】

2.2.14 星币获取|支付详情 【3.0新增】

2.2.15 机构自定义信息 【3.0新增】

2.2.16 社区话题信息 【3.0新增】

2.2.17 社区话题评论信息 【3.0新增】

2.2.18 机构信息 【5.0新增】

2.2.19 志愿者自定义信息配置 【5.0新增】

2.2.20 项目自定义信息配置 【5.0新增】

2.2.21 项目自定义支付信息配置 【5.0新增】

2.2.22 新闻公告

2.2.23 积分商品信息

2.2.24 积分商品订单信息

2.2.25 机构信息【7.0修改】

2.2.26 成就信息【7.0新增】

2.2.27 用户成长等级【7.0新增】

2.2.28 签到班次信息【7.0新增】

2.2.29 求助信息(新增)

2.2.30 基地信息

2.2.30 基地分类信息

3、接口列表

3.1 用户类接口

3.1.1 注册接口 [4.0修改]

3.1.2 登录接口 [4.0修改]

3.1.3 获取个人信息接口

3.1.4 完善个人信息接口 【7.0修改，个人信息接口中有have_pwd字断】

3.1.5 实名认证接口 [5.0修改]

3.1.5.1 修改个人资料接口 [5.0修改]

3.1.6 修改密码和找回密码接口

3.1.7 收藏【项目|团队】接口

3.1.8 删除收藏【项目|团队】接口

3.1.9 收藏【项目|团队】列表接口

3.1.10 我加入的团队列表接口

3.1.11 我加入的项目接口

3.1.12 我志愿时长接口

3.1.13 补录时长申请列表接口

3.1.14 补录时长申请接口

3.1.15 补录时长项目列表接口

1.2.6 城市下区域接口【3.0新增】

2.2.1 用户信息【7.0修改】

2.2.3 项目信息【5.0修改】

2.2.10 星级榜样信息【3.0新增】

2.2.11 保险信息【3.0新增】

2.2.12 认领项目信息【3.0新增】

2.2.13 认领信息【3.0新增】

2.2.14 星币获取|支付详情【3.0新增】

2.2.15 机构自定义信息【3.0新增】

2.2.16 社区话题信息【3.0新增】

2.2.17 社区话题评论信息【3.0新增】

2.2.18 机构信息【5.0新增】

2.2.19 志愿者自定义信息配置【5.0新增】

2.2.20 项目自定义信息配置【5.0新增】

2.2.21 项目自定义支付信息配置【5.0新增】

3.1.4 完善个人信息接口【7.0修改，个人信息接口中有have_pwd字断】

3.1.17 添加家庭成员接口【4.0修改】

3.1.20 打卡接口【3.0修改】

3.1.27 绑定家庭成员接口【4.0新增】

3.1.28 修改绑定家庭成员信息接口【4.0新增】

3.1.29 手机号注册登陆接口【5.0新增】

3.3.4 加入/退出项目【7.0修改】

3.4.1 团队列表接口【3.0修改】

3.3.6 项目支付结果【7.0新增】