蜂鸟接口文件0818

2016-08-18  本文已影响0人  我是个丑八怪

1游客模块

1.1 登陆功能

url:bird/public/index.php/all/login
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
email 邮箱 varchar 登陆邮箱
password 密码 varchar 登录密码
type 对象类型 varchar -

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array null
message 响应结果 varchar sucess,failed,inputerror三类

1.2退出登陆

url:bird/public/index.php/all/login
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array null
message 响应结果 varchar sucess,failed,inputerror三类

1.3 邮箱注册功能

url:bird/public/index.php/all/registere/email
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
email 邮箱 varchar 登陆邮箱
password 密码 varchar 登录密码
name 用户名 varchar -

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 说明
message 响应结果 varchar sucess,failed,inputerror三类

2 个人信息模块

2.1 基本信息修改

url:bird/public/index.php/info/info/changeinfo
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
name 昵称 varchar
education 最高教育经历 varchar
company 所在公司 varchar -
job 职业 varchar -

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 说明
message 响应结果 varchar sucess,failed,inputerror三类

2.2 修改头像

url:bird/public/index.php/info/info/headimg
method:post
输入:

参数名 说明 数据类型 是否必须 其他说明
file 头像图片 file -

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 说明
message 响应结果 varchar sucess,failed,inputerror三类

2.3 邮箱验证码发送

参数名 说明 数据类型 是否必须 其他说明

url:bird/public/index.php/info/info/emailverifysend
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 说明
message 响应结果 varchar sucess,failed,inputerror三类

2.4 验证邮箱

参数名 说明 数据类型 是否必须 其他说明
token 验证码 varchar

url:bird/public/index.php/info/info/emailverifysend
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
token 验证码 varchar

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 说明
message 响应结果 varchar sucess,failed,inputerror三类

2.5 修改密码

参数名 说明 数据类型 是否必须 其他说明
oldpasswd 旧密码 varchar
newpasswd 新密码 varchar

url:bird/public/index.php/info/info/passwd
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
oldpasswd 旧密码 varchar
newpasswd 新密码 varchar

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 说明
message 响应结果 varchar sucess,failed,inputerror三类

3 我的关注模块

3.1 查看所有关注的公司

参数名 说明 数据类型 是否必须 其他说明

url:bird/public/index.php/favor/favor/show
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 关注公司
message 响应结果 varchar sucess,failed,inputerror三类

3.2 检测一个公司是否已经被关注

参数名 说明 数据类型 是否必须 其他说明
company_id 公司id int

url:bird/public/index.php/favor/favor/check
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
company_id 公司id int

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array had和none,通过这个判断
message 响应结果 varchar sucess,failed,inputerror三类

3.3添加关注

参数名 说明 数据类型 是否必须 其他说明

url:bird/public/index.php/favor/favor/insert
method:get
输入:
| 参数名 | 说明 | 数据类型 |是否必须|其他说明
|:------:|:---示所有榜单
url:bird/public/index.php/lists/mylist/showlist
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 所有榜单
message 响应结果 varchar sucess,failed,inputerror三类

4.2 展示某个榜单的所有公司

参数名 说明 数据类型 是否必须 其他说明
list_id 榜单id int

url:bird/public/index.php/lists/mylist/showlistcompany
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
list_id 榜单id int

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 所有榜单
message 响应结果 varchar sucess,failed,inputerror三类

4.3 新建榜单

参数名 说明 数据类型 是否必须 其他说明
name 榜单名字 varchar
info 榜单说明 varchar
image 默认图片类 varchar

url:bird/public/index.php/lists/mylist/creat
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
name 榜单名字 varchar
info 榜单说明 varchar
image 默认图片类 varchar

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 所有榜单
message 响应结果 varchar sucess,failed,inputerror三类

4.4搜索后批量插入某一个榜单

参数名 说明 数据类型 是否必须 其他说明
ids 公司id 数组 -
list_id 榜单id int -

url:bird/public/index.php/lists/mylist/creat
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
ids 公司id 数组 -
list_id 榜单id int -

data字段包含上面数据的json:
实例:
url?data={"ids":[1,2,3],"list_id":7}
输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

5 搜索功能

5.1 搜索后批量插入某一个榜单

url:bird/public/index.php/select/select
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
name 公司名称(模糊搜索) varchar -
province 地点 varchar -
time 成立时间 varchar -
company_scale 公司规模 varchar -
investor 融资机构 varchar -
keyword 行业 数组 -
type and还是or varchar -
page 页码 varchar -

data字段包含上面数据的json:
实例:
{"investor":"红杉资本中国","province":"北京","company_scale":"50-150人","time":"2013","financing":"B轮","name":"1","keyword":["医疗健康","就医陪诊"],"type":"or"}

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6 公司展示

6.1 公司基本信息

url:bird/public/index.php/company/company
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.2 公司产品信息

url:bird/public/index.php/company/company/product
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.3 公司行业关键字

url:bird/public/index.php/company/company/keyword
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.4 公司成员

url:bird/public/index.php/company/company/member
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.5 公司里程碑信息

url:bird/public/index.php/company/company/milepost
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.6 公司融资信息

url:bird/public/index.php/company/company/financing
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.7公司加入榜单情况

url:bird/public/index.php/company/list/showlist
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
company_id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.8 公司加入榜单更新

url:bird/public/index.php/company/list/showlist
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
company_id 公司id int -
mylist 榜单更新结果 varchar -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类 ------: :-----: :-----: :-----:
company_id 公司id int

data字段用来显示上述输入信息
实例:{"company_id":980,"mylist":[{"id":1,"existence":"none"},{"id":2,"existence":"had"},{"id":3,"existence":"none"}]}
输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类 ------: :-----: :-----: :-----:
company_id 公司id int

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

4 我的榜单模块

4.1 展示所有榜单

参数名 说明 数据类型 是否必须 其他说明

url:bird/public/index.php/lists/mylist/showlist
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 所有榜单
message 响应结果 varchar sucess,failed,inputerror三类

4.2 展示某个榜单的所有公司

参数名 说明 数据类型 是否必须 其他说明
list_id 榜单id int

url:bird/public/index.php/lists/mylist/showlistcompany
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
list_id 榜单id int

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 所有榜单
message 响应结果 varchar sucess,failed,inputerror三类

4.3 新建榜单

参数名 说明 数据类型 是否必须 其他说明
name 榜单名字 varchar
info 榜单说明 varchar
image 默认图片类 varchar

url:bird/public/index.php/lists/mylist/creat
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
name 榜单名字 varchar
info 榜单说明 varchar
image 默认图片类 varchar

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array 所有榜单
message 响应结果 varchar sucess,failed,inputerror三类

4.4搜索后批量插入某一个榜单

参数名 说明 数据类型 是否必须 其他说明
ids 公司id 数组 -
list_id 榜单id int -

url:bird/public/index.php/lists/mylist/creat
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
ids 公司id 数组 -
list_id 榜单id int -

data字段包含上面数据的json:
实例:
url?data={"ids":[1,2,3],"list_id":7}
输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

5 搜索功能

5.1 搜索后批量插入某一个榜单

url:bird/public/index.php/select/select
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
name 公司名称(模糊搜索) varchar -
province 地点 varchar -
time 成立时间 varchar -
company_scale 公司规模 varchar -
investor 融资机构 varchar -
keyword 行业 数组 -
type and还是or varchar -
page 页码 varchar -

data字段包含上面数据的json:
实例:
{"investor":"红杉资本中国","province":"北京","company_scale":"50-150人","time":"2013","financing":"B轮","name":"1","keyword":["医疗健康","就医陪诊"],"type":"or"}

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6 公司展示

6.1 公司基本信息

url:bird/public/index.php/company/company
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.2 公司产品信息

url:bird/public/index.php/company/company/product
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.3 公司行业关键字

url:bird/public/index.php/company/company/keyword
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.4 公司成员

url:bird/public/index.php/company/company/member
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.5 公司里程碑信息

url:bird/public/index.php/company/company/milepost
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.6 公司融资信息

url:bird/public/index.php/company/company/financing
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.7公司加入榜单情况

url:bird/public/index.php/company/list/showlist
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
company_id 公司id int -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

6.8 公司加入榜单更新

url:bird/public/index.php/company/list/showlist
method:get
输入:

参数名 说明 数据类型 是否必须 其他说明
company_id 公司id int -
mylist 榜单更新结果 varchar -
参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类

data字段用来显示上述输入信息
实例:{"company_id":980,"mylist":[{"id":1,"existence":"none"},{"id":2,"existence":"had"},{"id":3,"existence":"none"}]}
输出:

参数名 说明 数据类型 是否必须 其他说明
code 标准回调 int
data 响应数据 array
message 响应结果 varchar sucess,failed,inputerror三类
上一篇 下一篇

猜你喜欢

热点阅读