接口需求文档

1.注册接口

1.接口地址：http://www.51qingyuan.com/register.php
2.支持格式：json
3.请求方式：post
4.请求参数：

名称必填类型说明
invitation_code 是 string 单位邀请码
phone_number 是 string 手机号码
verification_code 是 string 短信验证码

5.返回字段说明：

名称类型说明
error_code int 返回码
result string 返回说明
company string 所在单位

JSON返回示例

{
  "result":"注册可用",
  "company":"四川工人日报社",
  "error_code":"0"
}

2.注册信息提交接口

  • 注册成功后为此用户分配唯一的id

1.接口地址：http://www.51qingyuan.com/register_info.php
2.支持格式：json
3.请求方式：post
4.请求参数

名称必填类型说明
gender 是 bool 1代表男；0代表女
birthyear 是 int 生日年
birthmonth 是 int 生日月
birthday 是 int 生日日
turename 是 string 真实姓名
nickname 是 string 昵称
password 是 string 登录密码
passwordagain 是 string 确认密码
mailbox 是 string 登录邮箱
read_clause 是 bool 是否阅读条款：1表同意；0表不同意
province 是 string 所在地区省
municipality 是 string 所在地区市
county 是 string 所在地区县
census_register_p 否 string 户籍省
census_register_m 否 string 户籍市
marriage 是 int 0表示未婚；1表示离异；2表示丧偶
education 是 int 0表示中专以下；1表示中专；2表示大专；3表示本科；4表示硕士；5表示博士；6表示博士后
occupation 否 int 0表示在校学生；1表示计算机／互联网／IT；2表示电子／半导体／仪表仪器；3表示通信技术；4表示销售；5表示市场拓展；6表示公关／商务；7表示采购／贸易；8表示客户服务／激素支持；9表示人力资源／行政管理；10表示高级管理；11表示生产／加工／制造；12表示质控／安检；13表示工程机械；14表示技工；15表示会计／审计／统计；16表示金融／证券／投资；17表示房地产／装修／物业；18表示仓储／物流；19表示交通／运输；20表示普通劳动力／家政服务；21表示普通服务行业；22表示航空服务行业；23表示教育／培训；24表示咨询／顾问；25表示学术／科研；26表示法律；27表示设计／创意；28表示文学／传媒／影视；29表示餐饮／旅游；30表示化工；31表示能源／地质勘查；32表示医疗／护理；33表示保健／美容；34表示生物／制药／医疗器械；35表示体育工作者；36表示翻译；37表示公务员／国家干部；38表示私营业主；39表示农／林／牧／渔业；40表示警察／其他；41表示自由职业者；42其他
height 是 int 身高
soliloquy 是 string 内心独白

5.返回字段说明

名称类型说明
error_code int 返回码
result string 注册成功

JSON返回示例

{
  "result":"注册成功",
  "error_code":"0"
}

3.登录接口

1.接口地址：http://www.51qingyuan.com/login.php
2.支持格式：json
3.请求方式：post
4.请求参数：

名称必填类型说明
username 是 string 用户名
password 是 string 用户密码

5.返回字段说明

名称类型说明
error_code int 返回码
result string 登录成功
id string 用户的ID，每个用户只有唯一的ID

JSON返回示例

{
  "result":"登录成功",
  "id":"123456",
  "error_code":"0"
}

4.最新活动数据

  • 需要登录
  • 返回最新活动数据

1.接口地址：http://www.51qingyuan.com/new_activity.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 代表页数；每页最多存在10个活动数据

5.返回字段说明

名称类型说明
activity_number int 活动数目
activity_detial.name string 活动名称
activity_detial.address string 活动地址
activity_detial.date string 活动截止时间
activity_detial.image string 活动图片的URL
activity_detial.state bool 活动状态：0代表已结束
activity_detial.url string 活动详情页面的网页链接

JSON返回示例

{
    "activity_number":1,
    "activity_detial":[
    {
        "name":"达州活动专场---相约暖冬 缘定达州",
        "address":"达州 达州区",
        "date":"2016-3-29",
        "image":"",
        "state":0,
        "url":"http://www.51qingyuan.com/webapp.php?c=party&a=detail&id=23"
    }
    ]
}

5.全部活动数据

  • 需要登录
  • 返回全部活动数据

1.接口地址：http://www.51qingyuan.com/all_activity.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 代表页数；每页最多存在10个活动数据

5.返回字段说明

名称类型说明
activity_number int 活动数目
activity_detial.name string 活动名称
activity_detial.address string 活动地址
activity_detial.date string 活动截止时间
activity_detial.image string 活动图片的URL
activity_detial.state bool 活动状态：0代表已结束
activity_detial.url string 活动详情页面的网页链接

JSON返回示例

{
    "activity_number":1,
    "activity_detial":[
    {
        "name":"达州活动专场---相约暖冬 缘定达州",
        "address":"达州 达州区",
        "date":"2016-3-29",
        "image":"",
        "state":0,
        "url":"http://www.51qingyuan.com/webapp.php?c=party&a=detail&id=23"
    }
    ]
}

6.推荐用户数据

  • 需要登录
  • 若用户是男性用户则推荐女会员，若用户是女性用户则推荐男会员

1.接口地址：http://www.51qingyuan.com/users/recommendation.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 代表页数；每页最多存在10个推荐用户

5.返回字段说明

名称类型说明
recommendation_number int 推荐用户总数
recommendation_members.name string 用户名称
recommendation_members.gender bool 1代表男，0代表女
recommendation_members.age int 用户年龄
recommendation_members.marriage int 0表示未婚；1表示离异；2表示丧偶
recommendation_members.height int 身高
recommendation_members.constellation string 用户星座
recommendation_members.municipality string 所在地区市
recommendation_members.county string 所在地区县
recommendation_members.education int 0表示中专以下；1表示中专；2表示大专；3表示本科；4表示硕士；5表示博士；6表示博士后
recommendation_members.image string 用户图片等URL
recommendation_members.id string 用户的ID，每个用户只有唯一的ID

JSON返回示例

{
    "recommendation_members":[
    {
        "name":"宇帅帅",
        "gender":1,
        "age":26,
        "marriage":0,
        "height":186,
        "constellation":"巨蟹座",
        "municipality":"成都",
        "county":"成华区",
        "education":"3",
        "image":"http://www.51qingyuan.com/data/attachment/album/201411/07/69ef2d42aec014b1.jpg.thumb.jpg"
        "id":"123456"
    },
    ...
    ]
}

7.1用户数据（默认）

  • 需要登录
  • 用户数据默认的排序
  • 参数信息与推荐用户数据相同

1.接口地址：http://www.51qingyuan.com/users/default.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 代表页数；每页最多存在10个推荐用户

5.返回字段说明

名称类型说明
users_members.name string 用户名称
users_members.gender bool 1代表男，0代表女
users_members.age int 用户年龄
users_members.marriage int 0表示未婚；1表示离异；2表示丧偶
users_members.height int 身高
users_members.constellation string 用户星座
users_members.municipality string 所在地区市
users_members.county string 所在地区县
users_members.education int 0表示中专以下；1表示中专；2表示大专；3表示本科；4表示硕士；5表示博士；6表示博士后
users_members.head_image string 用户图片等URL
users_members.id string 用户的ID，每个用户只有唯一的ID

JSON返回示例

{
    "users_members":[
    {
        "name":"宇帅帅",
        "gender":1,
        "age":26,
        "marriage":0,
        "height":186,
        "constellation":"巨蟹座",
        "municipality":"成都",
        "county":"成华区",
        "education":3,
        "head_image":"http://www.51qingyuan.com/data/attachment/album/201411/07/69ef2d42aec014b1.jpg.thumb.jpg"
        "id":"123456"
    },
    ...
    ]
}

7.2用户数据（人气）

  • 需要登录
  • 数据参数和用户数据（默认）相同，但是按照用户人气来排序的。

1.接口地址：http://www.51qingyuan.com/users/hot.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 代表页数；每页最多存在10个推荐用户

7.3用户数据（最新登录）

  • 需要登录
  • 数据参数和用户数据（默认）相同，但是按照最新登录来排序的。

1.接口地址：http://www.51qingyuan.com/users/newly.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 代表页数；每页最多存在10个推荐用户

8.用户搜索

  • 需要登录
  • 返回数据参数和用户数据（默认）相同。

1.接口地址：http://www.51qingyuan.com/users/search.php
2.支持格式：json
3.请求方式：post
4.请求参数：

名称必填类型说明
municipality 否 string 所在地区市
county 否 string 所在地区县
gender 否 bool 1代表男；0代表女
age_from 否 int 0代表不限
age_to 否 int 0代表不限
height_from 否 int 0代表不限
height_to 否 int 0代表不限
weight_from 否 int 0代表不限
weight_to 否 int 0代表不限
salary_from 否 int 0代表不限
salary_to 否 int 0代表不限
education_from 否 int 0表示中专以下；1表示中专；2表示大专；3表示本科；4表示硕士；5表示博士；6表示博士后
education_to 否 int 0表示中专以下；1表示中专；2表示大专；3表示本科；4表示硕士；5表示博士；6表示博士后
marriage 否 int 0表示未婚；1表示离异；2表示丧偶
children 否 int 0表示不限；1表示无小孩；2表示有，和我住一起；3表示有，有时和我住一起；4表示有，不和我住一起
house 否 int 0表示不限；1表示暂未购房；2表示需要时置房；3表示已购住房；4表示与人合租；5表示独自租房；6表示与父母同住；7表示住亲朋家；8表示住单位房
car 否 int 0表示不限；1表示暂未购车；2表示已经购车
occupation 否 int 0表示在校学生；1表示计算机／互联网／IT；2表示电子／半导体／仪表仪器；3表示通信技术；4表示销售；5表示市场拓展；6表示公关／商务；7表示采购／贸易；8表示客户服务／激素支持；9表示人力资源／行政管理；10表示高级管理；11表示生产／加工／制造；12表示质控／安检；13表示工程机械；14表示技工；15表示会计／审计／统计；16表示金融／证券／投资；17表示房地产／装修／物业；18表示仓储／物流；19表示交通／运输；20表示普通劳动力／家政服务；21表示普通服务行业；22表示航空服务行业；23表示教育／培训；24表示咨询／顾问；25表示学术／科研；26表示法律；27表示设计／创意；28表示文学／传媒／影视；29表示餐饮／旅游；30表示化工；31表示能源／地质勘查；32表示医疗／护理；33表示保健／美容；34表示生物／制药／医疗器械；35表示体育工作者；36表示翻译；37表示公务员／国家干部；38表示私营业主；39表示农／林／牧／渔业；40表示警察／其他；41表示自由职业者；42其他
company 否 string  
head 否 int 0代表不限；1代表有头像

用户数据详情（主页）接口

  • 需要登录

1.接口地址：http://www.51qingyuan.com/users/detail.php?id＝123456
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
id 是 int 每个用户独有的唯一标识

5.返回字段说明

名称类型说明
name string 用户名称
gender bool 1代表男，0代表女
age int 用户年龄
marriage int 0表示未婚；1表示离异；2表示丧偶
height int 身高
head_image string 用户头像的URL
life_image.image string 用户相册图片的URL
monologue string 内心独白
basis.id string 每个用户独有的唯一标识
basis.education int 0表示中专以下；1表示中专；2表示大专；3表示本科；4表示硕士；5表示博士；6表示博士后
basis.marriage int 0表示未婚；1表示离异；2表示丧偶
basis.salary_from int 薪水从
basis.salary_to int 薪水到
basis.nation string 民族
basis.constellation string 星座
basis.zodiac string 生肖
basis.blood int 0表示其他，1表示A型，2表示B型，3表示AB型，4表示O型
basis.house int 0表示不限；1表示暂未购房；2表示需要时置房；3表示已购住房；4表示与人合租；5表示独自租房；6表示与父母同住；7表示住亲朋家；8表示住单位房
basis.car string 0表示不限；1表示暂未购车；2表示已经购车
basis.municipality string 所在地区市
basis.county string 所在地区县
basis.company string 所在公司
mate_requirements.gender bool 1代表男，0代表女
mate_requirements.age_from int 年龄从
mate_requirements.age_to int 年龄到
mate_requirements.height_from int 身高从
mate_requirements.height_to int 身高到
mate_requirements.education_from int 学历从
mate_requirements.education_to int 学历到
mate_requirements.have_iamge bool 0代表不限；1代表有
mate_requirements.marriage int 0表示未婚；1表示离异；2表示丧偶
mate_requirements.mate_type int 交友类型0代表朋友，1代表知己，2代表恋爱，3代表结婚
mate_requirements.municipality string 所在地区市
mate_requirements.county string 所在地区县
character_appearance.personality string 个性描述
character_appearance.looks int 相貌自评
character_appearance.weight int 体重
character_appearance.shape int 体型
character_appearance.charm int 魅力部位
character_appearance.hairstyle int 发型
character_appearance.hair_color int 发色
character_appearance.face int 脸型
work_study.occupation int 0表示在校学生；1表示计算机／互联网／IT；2表示电子／半导体／仪表仪器；3表示通信技术；4表示销售；5表示市场拓展；6表示公关／商务；7表示采购／贸易；8表示客户服务／激素支持；9表示人力资源／行政管理；10表示高级管理；11表示生产／加工／制造；12表示质控／安检；13表示工程机械；14表示技工；15表示会计／审计／统计；16表示金融／证券／投资；17表示房地产／装修／物业；18表示仓储／物流；19表示交通／运输；20表示普通劳动力／家政服务；21表示普通服务行业；22表示航空服务行业；23表示教育／培训；24表示咨询／顾问；25表示学术／科研；26表示法律；27表示设计／创意；28表示文学／传媒／影视；29表示餐饮／旅游；30表示化工；31表示能源／地质勘查；32表示医疗／护理；33表示保健／美容；34表示生物／制药／医疗器械；35表示体育工作者；36表示翻译；37表示公务员／国家干部；38表示私营业主；39表示农／林／牧／渔业；40表示警察／其他；41表示自由职业者；42其他
work_study.company_type int 公司类型
work_study.income int 收入描述
work_study.working_state int 工作状况
work_study.major int 所学专业
work_study.language int 语言能力
life_describe.sibling int 家中排行
life_describe.max_custom int 最大消费
life_describe.smoke int 是否吸烟
life_describe.drink int 是否喝酒
life_describe.religion int 宗教信仰
life_describe.exercise int 锻炼习惯
life_describe.rest int 作息习惯
life_describe.want_children int 是否要孩子
life_describe.live_with_parents int 愿与对方父母同住
life_describe.romance int 喜欢制造浪漫
hobby.sport int 喜欢的运动
hobby.food int 喜欢的食物
hobby.book int 喜欢的书籍
hobby.movie int 喜欢的电影
hobby.sparetime int 业余爱好
hobby.tourism int 喜欢的旅游去处
hobby.program int 关注的节目
hobby.entertainment int 娱乐休闲

JSON返回示例

{
    "name":"宇帅帅",
    "gender":1,
    "age":26,
    "marriage":0,
    "height":186,
    "head_image":"http://www.51qingyuan.com/data/attachment/album/201411/07/69ef2d42aec014b1.jpg.thumb.jpg"
    "life_image":[
    {
    "image":"http://www.51qingyuan.com/data/attachment/album/201411/07/69ef2d42aec014b1.jpg.thumb.jpg"
    },{
    "image":"http://www.51qingyuan.com/data/attachment/album/201411/07/69ef2d42aec014b1.jpg.thumb.jpg"
    },{
    "image":"http://www.51qingyuan.com/data/attachment/album/201411/07/69ef2d42aec014b1.jpg.thumb.jpg"
    }
    ],
    "monologue":"英俊潇洒，玉树临风，才比子建，貌若潘安。",
    "basis":{
        "id":"123456",
        "education":3,
        "marriage":0,
        "salary_from":5000,
        "salary_to":10000,
        "nation":"汉族",
        "constellation":"巨蟹座",
        "zodiac":"牛",
        "blood":0,
        "house":0,
        "car":0,
        "municipality":"成都",
        "county":"成华区",
        "company":"四川广播电台"
    }，
    "mate_requirements":{
        "gender":0,
        "age_from":18,
        "age_to":25,
        "height_from":180,
        "height_to":186,
        "education_from":0,
        "education_to":3,
        "have_iamge":0,
        "marriage":0,
        "mate_type":0,
        "municipality":"成都",
        "county":"成华区"
    }
    "character_appearance":{
        "personality":"豪放不羁",
        "looks":0,
        "weight":45,
        "shape":2,
        "charm":0,
        "hairstyle":0,
        "hair_color":3,
        "face":0
    },
    "work_study":{
        "occupation":0,
        "company_type":0,
        "income":2,
        "working_state":2,
        "major":3,
        "language":"中文，英文"
    },
    "life_describe":{
        "sibling":"家中独子",
        "max_custom":"美食",
        "smoke":1,
        "drink":0,
        "religion":0,
        "exercise":0,
        "rest":0,
        "want_children":0,
        "live_with_parents":1,
        "romance":0
    },
    "hobby":{
        "sport":1,
        "food":2,
        "book":1,
        "movie":3,
        "sparetime":4,
        "tourism":1,
        "program":1,
        "entertainment":1,
    }
}

“打招呼”请求接口

  • 需要登录

1.接口地址：http://www.51qingyuan.com/users/hello.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 每次返回5随机组问候语

5.返回字段说明：

名称类型说明
hello_words.code string 返回代码，一个招呼对应唯一的一个代码
hello_words.word string 招呼内容

JSON返回示例

{
    "hello_words":[
        {
            "code":"#203",
            "word":"你要是不给我回信，我就永远不给你写信了。"
        },
        {
            "code":"#20",
            "word":"你的名字真有意思，能告诉我有什么含义吗？"
        },
        ...
        ]
}

“打招呼”发送接口

  • 需要登录
  • 将消息发送给指定用户

1.接口地址：http://www.51qingyuan.com/users/hello_send.php?id=123456&code=#203
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
id 是 int 用户的唯一标识
code 是 int 问候语的代号

5.返回字段说明：

名称类型说明
result string 服务器返回结果
error_code string 错误代码

JSON返回示例

{
  "result":"发送成功",
  "error_code":"0"
}

“写信件”接口

  • 需要登录
  • 给对方发信件

1.接口地址：http://www.51qingyuan.com/users/letter/send.php
2.支持格式：json
3.请求方式：post
4.请求参数：

名称必填类型说明
id 是 int 用户的唯一标识
content 是 string 信件内容

5.返回字段说明：

名称类型说明
result string 服务器返回结果
error_code string 错误代码

JSON返回示例

{
  "result":"发送成功",
  "error_code":"0"
}

收件箱－全部信件接口

  • 需要登录

1.接口地址：http://www.51qingyuan.com/users/letter/receive／all_letters.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 每页最多10组信件信息

5.返回字段说明：

名称类型说明
letter_id int 信件的标识
time string 信件发送的时间
content string 信件内容
state bool 阅读状态：0代表未读，1代表已读
content string 信件内容
sender.id int 用户的唯一标识
sender.name string 发件人的名字
sender.image string 发件人的头像图片

JSON返回示例

{
  "letters":[
      {
        "letter_id":"201604070922",
        "time":"2016/04/07 09:22",
        "content":"没有你的世界好安静",
        "state":0
        "sender":{
            "id":123456,
            "name":"梅fish",
            "image":"www."
        },
      },
    ...
  ]
}

收件箱-未读信件接口

  • 需要登录
  • 返回字段数据和全部信件一样

1.接口地址：http://www.51qingyuan.com/users/letter/receive／unread_letters.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 每页最多10组信件信息

收件箱－已读信件接口

  • 需要登录
  • 返回字段数据和全部信件一样

1.接口地址：http://www.51qingyuan.com/users/letter/receive／read_letters.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 每页最多10组信件信息

阅读信件接口

1.接口地址：http://www.51qingyuan.com/users/letter/read.php?letter_id=201604070922
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
letter_id 是 int 信件的标识

5.返回字段说明：

名称类型说明
result string 服务器返回结果
error_code string 错误代码

JSON返回示例

{
  "result":"已阅读",
  "error_code":"0"
}

发件箱－全部信件

  • 需要登录

1.接口地址：http://www.51qingyuan.com/users/letter/send／all_letters.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 每页最多10组信件信息

5.返回字段说明：

名称类型说明
letter_id int 信件的标识
time string 信件发送的时间
content string 信件内容
state bool 阅读状态：0代表未读，1代表已读
content string 信件内容
receiver.id int 用户的唯一标识
receiver.name string 发件人的名字
receiver.image string 发件人的头像图片

JSON返回示例

{
  "letters":[
      {
        "letter_id":"201604070922",
        "time":"2016/04/07 09:22",
        "content":"没有你的世界好安静",
        "state":0
        "receiver":{
            "id":123456,
            "name":"梅fish",
            "image":"www."
        },
      },
    ...
  ]
}

发件箱-未读信件接口

  • 需要登录
  • 返回字段数据和全部信件一样

1.接口地址：http://www.51qingyuan.com/users/letter/send／unread_letters.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

名称必填类型说明
page 是 int 每页最多10组信件信息

发件箱－已读信件接口

  • 需要登录
  • 返回字段数据和全部信件一样

1.接口地址：http://www.51qingyuan.com/users/letter/send/read_letters.php?page=0
2.支持格式：json
3.请求方式：get
4.请求参数：

 

名称必填类型说明
page 是 int 每页最多10组信件信息

posted on 2017-06-29 14:58  梁飞宇  阅读(1706)  评论(0)  编辑  收藏  举报