帐户系统

1.验证码生成

1.1 接口 https://api.goowee.cn/v1/users/code

1.2 请求方式 POST

1.3 输入

{"username": "13611778890", "type": 1}
字段名称
类型
字段必须
备注

username

string

required

用户名称

type

integer

required

短信类型 值为:1:登录与注册,2:修改帐号验证码,3,4,5,6

type 可能的值说明:
1     :   "身份验证验证码"
2     :   "修改帐号验证码"
4     :   "帐号注销验证码"

1.4 输出

{
    "code":0,
    'message': "OK"
}
'message': "参数错误"
'message': "验证码发送过于频繁"
'message': "新用户不能找回密码,请选择其他登录方式"

1.5. 接口测试

1. 验证码验证

1.1 接口 https://api.goowee.cn/v1/users/check/code

1.2 请求方式 POST

1.3 输入

字段名称
类型
字段必须
备注

username

string

required

用户名称

type

integer

required

短信类型 值为:1:登录与注册,2:修改帐号验证码,3,4,5,6

code

integer

required

验证码

1.4 输出

1.5. 接口测试

2 用户登录+注册

2.1 接口 https://api.goowee.cn/v1/users/signIn 2.2 请求方式 POST

2.3 输入

字段名称
类型
字段必须
备注

username

string

required

用户名称

code

string

required or option

验证码

visitorId

string

option

前端生成的随机Id(设备Id),用于确定哪个游客,androidId or idfa,游客注册专用

2.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

visitorId

string

required

游客Id

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

  • token 为当前session信息

  • expire session过期时间

2.5. 接口测试

21 华为用户登录+注册

2.1 接口 https://api.goowee.cn/v1/users/hw/signIn 2.2 请求方式 POST

2.3 输入

字段名称
类型
字段必须
备注

code

string

required

华为 authorization code

visitorId

string

option

前端生成的随机Id(设备Id),用于确定哪个游客,androidId or idfa,游客注册专用

2.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

visitorId

string

required

游客Id

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

access_token

requires

登录验证码

  • token 为当前session信息

  • expire session过期时间

2.5. 接口测试

20 用户注销

20.1 接口 https://api.goowee.cn/v1/platform/logout 20.2 请求方式 POST

20.3 输入

字段名称
类型
字段必须
备注

username

string

required

用户名称

code

string

required

注销验证码

token

string

required

session 字串

20.4. 输出

20.5. 接口测试

3 用户信息更新

3.1 接口 https://api.goowee.cn/v1/users/update

3.2 请求方式 POST

3.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

token

string

required

token

gender

integer

option

性别 1:男 2:女

birthday

string

required or option

验证码

icon

string

option

头像唯一Id 一般为当前时间戳

nickname

string

option

昵称

email

string

option

邮箱

phoneno

string

option

绑定手机号

3.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

3.5. 接口测试

4 主场景信息

4.1 接口 https://api.goowee.cn/v1/scene/init 4.2 请求方式 POST

4.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

token

string

required

token

4.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

  • readInfo 最新阅读信息说明

字段名称
类型
字段必须
备注

bookId

string

require

最后阅读绘本Id

readTime

string

required

最后阅读时间

  • unlockInfo 解锁绘本信息为绘本Id列表

  • complete 读完的绘本Id列表

  • settingInfo 设置项信息说明

字段名称
类型
字段必须
备注

readingBooks

integer

required

每天可阅读的书数量

updateTime

integer

required

配置更新时间

  • orders 商品配置信息说明

字段名称
类型
字段必须
备注

orderId

string

require

商品Id

name

string

required

商品名称

icon

string

required

商品图标

prime

integer

required

原价

present

integer

required

现价

discount

integer

required

折扣

keys

integer

required

获取钥匙数

  • books 书籍配置信息说明

字段名称
类型
字段必须
备注

bookId

string

require

绘本Id

name

string

required

绘本名称

desc

string

required

绘本描述

icon

string

required

绘本图标

price

integer

required

钥匙价格

unlock

integer

required

解锁类型 0:免费解锁 1:钥匙解锁

discount

integer

required

折扣

order

integer

required

货架排序

show

integer

required

是否显示在大厅

4.5. 接口测试

5 点击阅读绘本

5.1 接口 https://api.goowee.cn/v1/books/click 5.2 请求方式 POST

5.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

bookId

string

required

绘本Id

token

string

required

token

5.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

5.5. 接口测试

6 使用钥匙解锁

6.1 接口 https://api.goowee.cn/v1/books/unlock 6.2 请求方式 POST

6.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

bookId

string

required

绘本Id

token

string

required

token

6.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

  • unlockInfo 解锁信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

6.5. 接口测试

7 支付发货接口

7.1 接口 https://api.goowee.cn/v1/orders/deliver 7.2 请求方式 POST

7.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

purchaseInfo

json string

required

购买信息 inAppPurchaseData->purchaseTokenData 部分

token

string

required

token

7.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

7.5. 接口测试

8 支付订单列表

8.1 接口 https://api.goowee.cn/v1/orders/list

8.2 请求方式 POST

8.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

token

string

required

token

8.4. 输出

  • orderInfo 信息结构说明

字段名称
类型
字段必须
备注

orderId

string

require

订单Id

createTime

string

required

订单创建时间 例如:2021-01-01 12:00:00

name

string

required

商品名称

keys

integer

required

钥匙购买量

price

float

required

支付金额

purchaseState

integer

required

-1:初始化 0:已购买 1:已取消 2:已退款

8.5. 接口测试

9 设置更新

9.1 接口 https://api.goowee.cn/v1/setting/update

9.2 请求方式 POST

9.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

token

string

required

token

readingBooks

integer

option

每次阅读数量 1-6 本

9.4. 输出

9.5. 接口测试

10 头像上传

10.1 接口 https://api.goowee.cn/v1/images/upload

10.2 请求方式 POST

10.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户名称

token

string

required

验证码

type

string

required

类型 icon:头像 ....

image

string required

图片base64字符串

10.4. 输出

10.5. 接口测试

10 修改绑定手机号

10.1 接口 https://api.goowee.cn/v1/users/bind/phone

10.2 请求方式 POST

10.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户帐号Id

code

string

required or option

验证码

phoneno

string

required

绑定手机号

10.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

  • token 为当前session信息

  • expire session过期时间

10.5. 接口测试

11 反馈信息接收

11.1 接口 https://api.goowee.cn/v1/users/questions/receiver

11.2 请求方式 POST

11.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户帐号Id

visitorId

string

option

游客Id

types

string

required

问题快捷选择 [0-8]中一项或几项

content

string

required

内容描述 500字符以内

contact

string

required or option

联系方式

token

string

required

当前登录凭证

11.4. 输出

11.5. 接口测试

12 活动奖励领取

12.1 接口 https://api.goowee.cn/v1/reward/claim

12.2 请求方式 POST

12.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户帐号Id

activityId

integer

required

活动Id 60001:880001, // 绑定手机号奖励. 60002:880003 // 问卷调查奖励

token

string

required

当前登录凭证

12.4. 输出

12.5. 接口测试

13 完成阅读绘本

13.1 接口 https://api.goowee.cn/v1/books/complete 13.2 请求方式 POST

13.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

bookId

string

required

绘本Id

token

string

required

token

13.4. 输出

13.5. 接口测试

14 苹果支付发货接口

14.1 接口 https://api.goowee.cn/v1/orders/receiver 14.2 请求方式 POST

14.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

receipt

string

required

Base64 App前端订单数据

env

integer

option

0:正式 1:测试 环境

token

string

required

token

14.4. 输出

14.5. 接口测试

15 点击听音频

15.1 接口 https://api.goowee.cn/v1/audio/listen 15.2 请求方式 POST

15.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

visitorId

string

option

游客Id

audioId

string

required

音频Id

token

string

required

token

15.4. 输出

15.5. 接口测试

16 绘本分享

16.1 接口 https://api.goowee.cn/v1/books/share 16.2 请求方式 POST

16.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

bookId

string

required

绘本Id

token

string

required

token

16.4. 输出

  • userInfo信息结构说明

字段名称
类型
字段必须
备注

userId

string

require

用户Id

username

string

required

用户名称

nickname

string

required or option

用户昵称

gender

integer

required

性别 1:男 2:女

birthday

string

required

生日

keys

integer

required

钥匙

icon

string

required

用户头像

new

integer

required

是否新用户

16.5. 接口测试

17 绘本事件

17.1 接口 https://api.goowee.cn/v1/books/trigger 17.2 请求方式 POST

17.3 输入

字段名称
类型
字段必须
备注

userId

string

required

用户Id

bookId

string

required

绘本Id

eventId

string

required

事件key

token

string

required

token

17.4. 输出

最后更新于