【接口文档】
地址:
http://www.pinkjiao.com/app_server/v1.0/reg.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
accountNumber |
注册用户的账号。 |
phone |
注册用户的电话。 |
name |
注册用户的姓名。 |
password |
注册用户的MD5算法加密后密码。 |
gender |
注册用户性别(0表示女性,1表示男性)。 |
birthday |
注册用户的生日。 |
nationalIdNumber |
注册用户的身份证号。 |
返回数据:
注册成功时,返回的JSON数据结构为{"state":"ok","code":验证码},验证码是服务端生成的五位随机数。
错误码 |
错误提示信息 |
error501 |
用户名包含禁用字符串。 |
error502 |
账号已存在。 |
error503 |
复制头像失败。 |
error504 |
验证码错误。 |
error505 |
数据格式不符合规范。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/regCheckCode.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
accountNumber |
注册用户的账号。 |
password |
注册用户的MD5算法加密后密码。 |
registrationCode |
验证码。 |
返回数据:
验证验证码成功时,返回的JSON数据为{"state":"ok"}。注册和验证验证码失败时,返回的JSON数据结构为{"state":"错误码","info":"错误提示信息"}。
地址:
http://www.pinkjiao.com/app_server/v1.0/forgetPassword.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
accountNumber |
注册用户的账号。 |
phone |
注册用户的电话。 |
name |
注册用户的姓名。 |
nationalIdNumber |
注册用户的身份证号。 |
返回数据:
找回成功时,返回的JSON数据结构为{"state":"ok","code":验证码}。找回失败时,返回的JSON数据结构为{"state":"错误码","info":"错误提示信息"}。
错误码 |
错误提示信息 |
error701 |
密码错误。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/forgetPasswordCheckCode.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
accountNumber |
注册用户的账号。 |
phone |
注册用户的电话。 |
name |
注册用户的姓名。 |
nationalIdNumber |
注册用户的身份证号。 |
password |
注册用户的MD5算法加密后的新密码。 |
forgetPasswordCode |
验证码。 |
返回数据:
验证验证码成功时,返回的JSON数据为{"state":"ok"}。验证验证码失败时,返回的JSON数据结构为{"state":"错误码","info":"错误提示信息"}。
错误码 |
错误提示信息 |
error702 |
验证码错误。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/login.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
accountNumber |
登录用户的账号。 |
password |
登录用户的MD5算法加密后密码。 |
返回数据:
登录成功时,返回的JSON数据为{"state":"ok", 'user' => {登录用户数据的JSON数组}}。
键名 |
说明 |
userAccountID |
登录用户的账号ID。 |
userName |
登录用户的姓名。 |
userFaceImage |
登录用户的头像图片地址。 |
userNationalIDImageCheck |
登录用户的身份证验证状态。 |
登录失败时,返回的JSON数据结构为{"state":"错误码","info":"错误提示信息"}。
错误码 |
错误提示信息 |
error601 |
账号错误。 |
error602 |
账号未激活。 |
error603 |
账号有限期锁定。 |
error604 |
账号无限期锁定。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/dynamicList.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号 |
developerKey |
开发序列号 |
currentUserAccountID |
登录用户的账号 |
currentUserPassword |
登录用户的MD5算法加密后密码 |
start |
开始加载的序号 |
num |
加载数量 |
返回数据:
获取动态列表数据成功时,返回的JSON数据为{"state":"ok","dynamicList":[动态列表数据的JSON数组]} 。没有动态列表数据时,返回的JSON数据为{"state":"ok","dynamicList":[]}。
键名 |
说明 |
userName |
用户姓名。 |
userAccountID |
用户账号ID。 |
userFaceImage |
用户头像图片地址。 |
dynamicID |
动态ID。 |
dynamicContent |
动态内容。 |
dynamicImage0 |
第一张动态图片地址。 |
dynamicImage1 |
第二张动态图片地址。 |
dynamicImage2 |
第三张动态图片地址。 |
dynamicImage3 |
第四张动态图片地址。 |
dynamicLabel |
动态标签。 |
dynamicCreateTime |
动态发布时间。 |
dynamicReplyNum |
动态的回复数量。 |
dynamicReplyPrivateNum |
动态的私回数量。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/searchDynamicList.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号 |
developerKey |
开发序列号 |
currentUserAccountID |
登录用户的账号 |
currentUserPassword |
登录用户的MD5算法加密后密码 |
searchKey |
搜索关键字 |
start |
开始加载的序号 |
num |
加载数量 |
返回数据:
搜索动态列表数据成功时,返回的JSON数据为{"state":"ok","dynamicList":[动态列表数据的JSON数组]} 。没有动态列表数据时,返回的JSON数据为{"state":"ok","dynamicList":[]}。
键名 |
说明 |
userName |
用户姓名。 |
userAccountID |
用户账号ID。 |
userFaceImage |
用户头像图片地址。 |
dynamicID |
动态ID。 |
dynamicContent |
动态内容。 |
dynamicImage0 |
第一张动态图片地址。 |
dynamicImage1 |
第二张动态图片地址。 |
dynamicImage2 |
第三张动态图片地址。 |
dynamicImage3 |
第四张动态图片地址。 |
dynamicLabel |
动态标签。 |
dynamicCreateTime |
动态发布时间。 |
dynamicReplyNum |
动态的回复数量。 |
dynamicReplyPrivateNum |
动态的私回数量。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/userDynamicList.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号 |
developerKey |
开发序列号 |
currentUserAccountID |
登录用户的账号 |
currentUserPassword |
登录用户的MD5算法加密后密码 |
searchKey |
搜索关键字 |
start |
开始加载的序号 |
num |
加载数量 |
返回数据:
获取用户的动态列表数据成功时,返回的JSON数据为{"state":"ok","dynamicList":[动态列表数据的JSON数组]} 。没有动态列表数据时,返回的JSON数据为{"state":"ok","dynamicList":[]}。
键名 |
说明 |
userName |
用户姓名。 |
userAccountID |
用户账号ID。 |
userFaceImage |
用户头像图片地址。 |
dynamicID |
动态ID。 |
dynamicContent |
动态内容。 |
dynamicImage0 |
第一张动态图片地址。 |
dynamicImage1 |
第二张动态图片地址。 |
dynamicImage2 |
第三张动态图片地址。 |
dynamicImage3 |
第四张动态图片地址。 |
dynamicLabel |
动态标签。 |
dynamicCreateTime |
动态发布时间。 |
dynamicReplyNum |
动态的回复数量。 |
dynamicReplyPrivateNum |
动态的私回数量。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/dynamicAdd.php
请求方式:
post
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
dynamicContent |
动态的内容。 |
uploadInput |
动态的图片(可选)。 |
dynamicLabel |
动态的标签(可选)。 |
返回数据:
发布动态成功时,返回的JSON数据为{"state":"ok"}。发布动态失败时,返回的JSON数据为{"state":"错误码","info":"错误提示信息"}。
错误码 |
错误提示信息 |
error804 |
发布动态失败。 |
error805 |
动态数据有误。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/dynamicReplyList.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
dynamicReplyDynamicID |
被回复的动态ID。 |
start |
开始加载的序号。 |
num |
加载数量。 |
返回数据:
获取回复列表数据成功时,返回的JSON数据为{"state":"ok","count" => "回复列表数据的JSON数组长度","dynamicReplyList":[回复列表数据的JSON数组]} 。没有获取到回复列表数据时,返回的JSON数据为{"state":"ok","count" => "0"}。
键名 |
说明 |
userName |
用户姓名。 |
userAccountID |
用户账号ID。 |
userFaceImage |
用户头像图片地址。 |
dynamicReplyID |
回复ID。 |
dynamicReplyContent |
回复内容。 |
dynamicReplyCreateTime |
回复发布时间。 |
dynamicReplyDynamicID |
回复的动态ID。 |
dynamicReplyRepliedDynamicReplyID |
回复的回复ID。 |
dynamicReplyPrivateFlag |
回复的私密标记(0为回复,1为私回)。 |
repliedUserName |
被回复的用户姓名。 |
repliedUserAccountID |
被回复的用户账号ID。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/messageRead.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
messageID |
消息ID。 |
返回数据:
设置消息已读取标记成功时,返回的JSON数据为{"state":"ok"}。设置消息已读取标记失败时,返回的JSON数据为{"state":"error1206","info":"消息不存在"}。
地址:
http://www.pinkjiao.com/app_server/v1.0/userInfo.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
userAccountID |
用户账号ID。 |
返回数据:
设置消息已读取标记成功时,返回的JSON数据为{"state":"ok"}。设置消息已读取标记失败时,返回的JSON数据为{"state":"error1206","info":"消息不存在"}。
地址:
http://www.pinkjiao.com/app_server/v1.0/userInfo.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
userAccountID |
用户账号ID。 |
返回数据:
取用户数据成功时,返回的JSON数据为{"state":"ok", "followFlag":"是否关注当前用户(0表示未关注,1表示已关注)","user":[用户数据的JSON数组]} 。获取登录用户数据时,followFlag键名和键值会省略。获取用户数据失败时,返回的JSON数据为{"state":"error1001","info":"用户账号ID错误"}。
键名 |
说明 |
userAccountID |
用户账号ID。 |
userName |
用户姓名。 |
userGender |
用户性别(0表示女性,1表示男性)。 |
userFaceImage |
用户头像地址。 |
userRegistrationTime |
用户注册时间。 |
userLock |
用户锁定状态(0表示未锁定,1表示未激活,2表示有期限锁定,3表示无期限锁定)。 |
userNationalIDImageCheck |
用户身份证验证状态(0表示待提交,1表示已提交,2表示驳回验证,3表示通过验证)。 |
userFollowNum |
用户的关注数量。 |
userFollowerNum |
用户的粉丝数量。 |
userDynamicNum |
用户发布的动态数量。 |
sendMessageNum |
用户发送的私信数量。 |
receiveMessageNum |
用户接收的私信数量。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/dynamicReplyAdd.php
请求方式:
post
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
dynamicReplyPrivateFlag |
私回标记(0表示回复,1表示私回)。 |
dynamicReplyContent |
回复内容。 |
dynamicReplyDynamicID |
被回复的动态ID。 |
dynamicReplyRepliedDynamicReplyID |
被回复的回复ID。 |
返回数据:
发布回复成功时,返回的JSON数据为{"state":"ok"}。发布回复失败时,返回的JSON数据为{"state":"错误码","info":"错误提示信息"}。
错误码 |
错误提示信息 |
error901 |
回复数据有误。 |
error902 |
发送回复失败。 |
error903 |
被回复的回复ID不存在。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/followList.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
start |
开始加载的序号。 |
num |
数量。 |
返回数据:
获取关注数据成功时,返回的JSON数据为{"state":"ok","followList":[关注列表数据的JSON数组]} 。没有关注的用户时,返回的JSON数据为{"state":"ok","followList" =>"[]"}。
键名 |
说明 |
userName |
用户姓名。 |
userAccountID |
用户账号ID。 |
userFaceImage |
用户头像图片地址。 |
followBecomeTime |
关注时间。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/followerList.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
start |
开始加载的序号。 |
num |
数量。 |
返回数据:
获取粉丝列表数据成功时,返回的JSON数据为{"state":"ok","followList":[粉丝列表数据的JSON数组]} 。没有粉丝时,返回的JSON数据为{"state":"ok","followList" =>"[]"}。
键名 |
说明 |
userName |
用户姓名。 |
userAccountID |
用户账号ID。 |
userFaceImage |
用户头像图片地址。 |
followBecomeTime |
关注时间。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/searchDynamicKeys.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
searchKey |
搜索关键字。 |
返回数据:
搜索到关键字提示时,返回的JSON数据为{"state":"ok","searchKeyList":[关键字提示列表数据的JSON数组]} 。没有搜索到关键字提示时,返回的JSON数据为{"state":"error802","info" =>"动态关键字不存在"}。
键名 |
说明 |
searchKey |
关键字。 |
count |
与关键字相关的动态数量。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/searchDynamicList.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
searchKey |
搜索关键字。 |
start |
开始加载的序号 |
num |
数量 |
返回数据:
搜索到关键字提示时,返回的JSON数据为{"state":"ok","dynamicList":[动态列表数据的JSON数组]}。没有搜索到动态时,返回的JSON数据为{"state":"error801","info" =>"动态不存在"}。
地址:
http://www.pinkjiao.com/app_server/v1.0/messageSend.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
receiverUserAccountID |
接收者的用户账号ID。 |
receiverUserName |
接收者的用户姓名。 |
messageContent |
私信内容。 |
返回数据:
发送私信成功时,返回的JSON数据为{"state":"ok"} 。发送私信失败时,返回的JSON数据为{"state":"错误码","info" =>"错误提示信息"}。
错误码 |
错误提示信息 |
error1201 |
私信发送失败。 |
error1202 |
私信数据错误。 |
error1203 |
不能向自己发送私信。 |
error1204 |
私信接收者不存在。 |
地址:
http://www.pinkjiao.com/app_server/v1.0/setupFaceImage.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
uploadInput |
用户头像图片。 |
返回数据:
设置头像成功时,返回的JSON数据为{"state":"ok"} 。设置头像失败时,返回的JSON数据为{"state":"error1401","info" =>"设置头像失败"}。
地址:
http://www.pinkjiao.com/app_server/v1.0/setupPassword.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
nationalIDNumber |
身份证号。 |
currentPassword |
MD5算法加密后的当前密码。 |
newPassword |
MD5算法加密后的新密码 |
返回数据:
重置密码成功时,返回的JSON数据为{"state":"ok"} 。重置密码失败时,返回的JSON数据为{"state":"error1403","info" =>"修改密码失败"}。
地址:
http://www.pinkjiao.com/app_server/v1.0/setupCheckNationalIDImage.php
请求方式:
get
请求数据:
参数 |
说明 |
developerAccountNumber |
开发者账号。 |
developerKey |
开发序列号。 |
currentUserAccountID |
登录用户的账号。 |
currentUserPassword |
登录用户的MD5算法加密后密码。 |
uploadInput |
身份证图片。 |
返回数据:
提交验证身份证成功时,返回的JSON数据为{"state":"ok"} 。提交验证身份证失败时,返回的JSON数据为{"state":"错误码","info" =>"错误提示信息"}。
错误码 |
错误提示信息 |
error1404 |
未上传身份证图片。 |
error1205 |
身份证正在审核中。 |
error1206 |
身份证已经通过验证。 |
error1207 |
上传身份证失败。 |
版权所有 始于2020年
ICP备案号:辽ICP备17018332号-2号