@lina 2016-05-20T03:55:29.000000Z 字数 4787 阅读 1061

益宠公益-用户端1.0 APP接口文档

益宠公益 api 1.0 iOS Android

第一部分通用约定

1 通用请求字段

1.1.1 鉴权字段

token : [string] 登录后获取的登录认证信息

1.2 通用响应字段

1.2.1 状态字段

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

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

1.2.2 数据字段

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

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

1.2.3 分页字段

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

currentPage: [int] 当前页码

totalPage: [int] 总页数

pageSize: [int] 每页数量

示例

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

1.3 通用接口

1.3.1 上传图片

通用上传文件服务

请求URL

POST

请求参数

token

file : 文件

响应

{
    errorCode: 0,
    data: {
        id: "9d377b10ce778c4938b3c7e2c63a229a.jpg",
        w: 1024,
        h: 768
    }
}

id : [string] 头像名称

w : [int] 头像宽度

h : [int]头像宽度

1.4 通用数据结构

1.4.1 宠物颜色

{
    id: 123,
    name: '白色'
}

id: [int] 颜色id

name: [string] 颜色显示名称：全部|白色|黑色|棕色|黄色|灰色|花色

1.4.2 犬体型

{
    id: 123,
    name: '大型犬'
}

id: [int] 体型id

name: [string] 体型显示名称：全部|小型犬|中型犬|大型犬

1.4.3 性别

{
    id: 123,
    name: '女孩'
}

id: [int] 性别id：0|1|2

name: [string] 性别显示名称：全部|男孩|女孩

1.4.4 地址

{
    name: '鼓楼大街小区',
    fullAddress: '北京市鼓楼大街小区23号楼',
    latitude:106.3,
    longitude:39.6
}

name: [string]

fullAddress: [string]

latitude: [float] 维度

longitude: [float] 经度

1.4.5 宠物列表信息

{
    id: 123,
    pet_code: 'YC00001',
    name : '帅帅',
    age: '1岁5个月',
    profile: 'http://xxxxx',
    is_immuned : 1,
    is_sterilization: 1,
    color : '@宠物颜色',
    sex: '@性别',
    figure : '@犬体型',
    is_adopted: 0,
    adoption_time: 14839000,
    distance:13000,
    publisher: {helper:'@救助人',organization:'@救助机构',
    public_time: 1429549593193,
    },
}

id: [int] 宠物ID

pet_code: [string] 宠物编码:【规则】YC大写00001~99999

name: [string] 名字

age: [string] 年龄

profile: [string] 头像Url（领养后由宠物主人上传；领养前为救助人或者机构上传）16:9

is_immuned : [bool] 是否免疫

is_sterilization : [bool] 是否绝育

color : [object] '@宠物颜色'

sex : [object] '@性别'

figure : [object] '@犬体形'

is_adopted : [bool] 是否被领养

adoption_time : [int] 领养时间戳

distance: [float]距离本手机定位的距离

publisher: [object] helper和organization人选其一

public_time: [int]发布时间

1.4.6 宠物详情

{
    pet: '@宠物列表信息',
    publisher_comment : '这只狗狗非常的活泼温顺，xxxx'
    shop: ['@爱心商盟','@爱心商盟'],
    detail_image : ['http://xxxxx','http://xxxxx'],
    video: '@视频',
}

pet: [object]宠物信息
helper_comment: [string] 发布者对狗狗的评价
shop: [array]商铺数组
detail_image:[array]详情图片16:9
video: [object] 视频对象

1.4.7 用户

{
    id: 1,
    name: '李娜',
    nickname:'老板',
    profile: 'http://xxxxxx',
    sex: '@性别',
    is_married:1
    is_allergy:1
    has_pet:1
    pet_habit:2
    moving_affect:3
}

id: [int] 人 ID

name: [string] 名字

nickname: [string] 昵称

profile: [string] 头像地址

is_married: [bool] 是否已婚

is_allergy: [bool] 是否过敏

has_pet: [bool] 是否有宠物

pet_habit: [int] 是否了解宠物习惯：1:熟悉 2:一般 3:不知道

moving_affect: [int] 搬家是否有影响：1:没影响 2:有影响 3:不好说

1.4.8 救助人

{
    id: 1,
    name: '李娜',
    nickname:'老板',
    profile: 'http://xxxxxx',
    sex: '@性别',
    telephone: '010-8900077',
    address: '@地址'
}

id: [int] 人 ID

name: [string] 名字

nickname: [string] 昵称

profile: [string] 头像地址

sex: [object] 性别

telephone : [string] 电话可以是座机或者手机

address : [object]'@地址'

1.4.9 救助机构

{
    id: 1,
    name: '北京领养日公益机构',
    logo: 'http://xxxxxx',
    telephone: '010-8900077',
    address: '@地址'
}

id: [int] 机构 ID

name: [string] 名字

logo: [string] 机构图片1：1

telephone : [string] 电话可以是座机或者手机

address : [object]'@地址'

1.4.10 爱心商盟

{
    id: 1,
    name: '北京领养日公益机构',
    logo: 'http://xxxxxx',
    telephone: '010-8900077',
    address: '@地址'
    introduction: '本医院位于xxx',
    service: '本宠物的洗澡美容由本医院免费提供，如果领养成功，本店继续提供',
    type: 1
}

id: [int] 机构 ID

name: [string] 名字

logo: [string] 机构图片1:1

telephone : [string] 电话可以是座机或者手机

address : [object]'@地址'

introduction: [string] 简介

service: [string]爱心服务

type: [int] 1：宠物店 2：宠物医院

1.4.11 故事

{
    id: 1,
    content: '益宠公益开展领养人宠物知识培训活动益宠公益开展领养人宠物知识培训活动益宠公益开展领养人宠物知识培训活动益宠公益开展领养人宠物知识培训活动',
    public_time: 14899000,
    publisher:'@用户',
    pet:'@宠物列表信息',
    images:['http://xxxxxx','http://xxxxxx'],
    agree_num:100
}

id: [int] 故事 ID

content: [string] 发布内容

public_time : [int] 发表时间:时间戳

publisher: [object] 发布人User

pet : [object]

images : [array] 发布图片数组1:1

agree_num : [int] 被赞的数目

1.4.12 活动

{
    id: 1,
    title: '益宠公益开展领养人宠物知识培训活动',
    content: '益宠公益开展领养人宠物知识培训活动益宠公益开展领养人宠物知识培训活动益宠公益开展领养人宠物知识培训活动益宠公益开展领养人宠物知识培训活动',
    summary: '益宠公益开展领养人宠物知识培训活动',
    address: '@地址',
    telephone: '010-8900077',
    person_incharge: '李娜',
    thumbnail: 'http://xxxxxx',
    detail_image: 'http://xxxxxx',
    start_time: 14899000,
    public_time: 14899000
    detail_image: 'http://xxxxxx',
}

id: [int] 活动 ID

title: [string] 活动名称

content: [string] 活动内容详情

summary: [string] 活动摘要

address : [object]'@地址'

telephone : [string] 电话可以是座机或者手机

person_incharge : [string]负责人

thumbnail : [string] 缩略图1:1

detail_image : [string] 详情图

start_time : [int] 活动时间

public_time : [int] 发表时间

1.4.13 视频

{
    cover: 'http://xxxxxx',
    video: 'http://xxxxxx'
}

cover: [string] 视频封面

video: [string] 视频地址

第二部分 API 接口

【测试Base】http://huiyangche.duapp.com/yc/mock
【线上Base】

请求 header Content-Type:application/json

2 领养

2.1 领养列表（狗+猫）

请求URL

POST /pet/list/dog
POST /pet/list/cat
【测试】狗
【测试】猫
【正式】

响应

{
    error_code: 0,
    data: {
     list: [
            '@宠物列表信息'
        ],
        pageInfo: [
            '@分页字段'
        ]
    }
}

2.2 宠物详情

请求URL

POST /pet/detail/{id}
【测试】
【正式】

响应

{
    error_code: 0,
    data: {
        '@宠物详情'
    }
}

3 故事

3.1 故事列表（Tab）

请求URL

POST /story/list
【测试】
【正式】

响应

{
    error_code: 0,
    data: {
     list: [
            '@故事'
        ],
        pageInfo: [
            '@分页字段'
        ]
    }
}

3.2 我的宠物故事列表（我的）

请求URL

POST /my/stories
【测试】
【正式】

响应

{
    error_code: 0,
    data: {
     list: [
            '@故事'
        ],
        pageInfo: [
            '@分页字段'
        ]
    }
}

4 活动

4.1 活动列表

请求URL

POST /activity/list
【测试】
【正式】

响应

{
    error_code: 0,
    data: {
     list: [
            '@活动'
        ],
        pageInfo: [
            '@分页字段'
        ]
    }
}

4.2 活动详情

请求URL

/activity/detail/{id}
POST
【测试】
【正式】

响应

{
    error_code: 0,
    data: {
        '@活动'
    }
}

5 个人中心

5.1 我的宠物列表

请求URL

POST /my/pets
【测试】
【正式】

响应

{
    error_code: 0,
    data: {
     list: [
            '@宠物列表'
        ]
}

6 爱心商盟

4.1 shop列表

请求URL

POST /shop/list
【测试】
【正式】

响应

{
    error_code: 0,
    data: {
     list: [
            '@爱心商盟'
        ],
        pageInfo: [
            '@分页字段'
        ]
    }
}

益宠公益-用户端1.0 APP接口文档

第一部分 通用约定

1 通用请求字段

1.1.1 鉴权字段

1.2 通用响应字段

1.2.1 状态字段

1.2.2 数据字段

1.2.3 分页字段

1.3 通用接口

1.3.1 上传图片

1.4 通用数据结构

1.4.1 宠物颜色

1.4.2 犬体型

1.4.3 性别

1.4.4 地址

1.4.5 宠物列表信息

1.4.6 宠物详情

1.4.7 用户

1.4.8 救助人

1.4.9 救助机构

1.4.10 爱心商盟

1.4.11 故事

1.4.12 活动

1.4.13 视频

第二部分 API 接口

2 领养

2.1 领养列表（狗+猫）

2.2 宠物详情

3 故事

3.1 故事列表（Tab）

3.2 我的宠物故事列表（我的）

4 活动

4.1 活动列表

4.2 活动详情

5 个人中心

5.1 我的宠物列表

6 爱心商盟

4.1 shop列表

内容目录

选择主题

第一部分通用约定