183 lines
3.9 KiB
Markdown
183 lines
3.9 KiB
Markdown
## 梦工厂后台AIP文档
|
|
|
|
### Api格式规范
|
|
- 请求URL {IP}:{port}/{接口名}
|
|
- 请求方式 POST
|
|
- 请求参数 json
|
|
- 签名秘钥 @234%67g12q4*67m12#4l67!
|
|
- 签名方式 sign = k1=v1&k2=v2&key=@234%67g12q4*67m12#4l67!
|
|
- 注意 签名字段需要按字段名排序拼接
|
|
|
|
### 样例Api
|
|
- 接口名:test
|
|
- 接口说明:样例接口 提供api文档规范
|
|
- 请求地址:{IP}:{port}/test
|
|
- 请求参数:id(测试id|签名),name(测试名称|签名),items(内嵌接口演示|不签名),sign(签名)
|
|
- 请求样例
|
|
```
|
|
{
|
|
"id":"001",
|
|
"name":"test"
|
|
"items":[
|
|
{
|
|
"A":"",
|
|
"T":"",
|
|
"N":0
|
|
}
|
|
],
|
|
"sign":"asjioqiowjeioqjweijqwejoi"
|
|
}
|
|
```
|
|
- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
|
|
- 返回样例
|
|
```
|
|
{
|
|
"code":0,
|
|
"msg":"成功",
|
|
"data":"",
|
|
}
|
|
```
|
|
|
|
### 跨服服务列表同步API
|
|
- 接口名:synccross
|
|
- 接口说明:跨服下区服列表新增时调用,通知目标跨服服务器同步区服列表
|
|
- 请求地址:{IP}:{port}/synccross
|
|
- 请求参数:timestamp(请求时间戳|签名),sign(签名)
|
|
- 请求样例
|
|
```
|
|
{
|
|
"timestamp":2156546515,
|
|
"sign":"asjioqiowjeioqjweijqwejoi"
|
|
}
|
|
```
|
|
- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
|
|
- 返回样例
|
|
```
|
|
{
|
|
"code":0,
|
|
"msg":"成功",
|
|
"data":"",
|
|
}
|
|
```
|
|
|
|
### 邮件发放API
|
|
- 接口名:createmail
|
|
- 接口说明:web 服务器给玩家发送邮件
|
|
- 请求地址:{IP}:{port}/createmail
|
|
- 请求参数:uid(uid|签名),title(title|签名),contex(contex|签名),cid(多语言文本ID|签名),items(附件|不签名),param(多语言序列化参数|不签名),sign(签名)
|
|
- 请求样例
|
|
```
|
|
{
|
|
"uid":"df01_000001",
|
|
"title":"xxxx",
|
|
"contex":"xxxxx",
|
|
"items":[
|
|
{
|
|
"A":"",
|
|
"T":"",
|
|
"N":0
|
|
}
|
|
],
|
|
"Cid":"",
|
|
"param":[
|
|
"001",
|
|
"002"
|
|
]
|
|
"sign":"asjioqiowjeioqjweijqwejoi"
|
|
}
|
|
```
|
|
- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
|
|
- 返回样例
|
|
```
|
|
{
|
|
"code":0,
|
|
"msg":"成功",
|
|
"data":"",
|
|
}
|
|
```
|
|
|
|
### 支付发货API
|
|
- 接口名:paydelivery
|
|
- 接口说明:web 服务器给玩家发送支付获得商品
|
|
- 请求地址:{IP}:{port}/paydelivery
|
|
- 请求参数:uid(用户id|签名),productid(商品id|签名),orderid(订单号|签名),price(总金额|签名),sign(签名)
|
|
- 请求样例
|
|
```
|
|
["uid","productid","orderid","price","sign"]
|
|
```
|
|
- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
|
|
- 返回样例
|
|
```
|
|
{
|
|
"code":0,
|
|
"msg":"成功",
|
|
"data":"",
|
|
}
|
|
```
|
|
|
|
### 修改服务器时间
|
|
- 接口名:modifyopentime
|
|
- 接口说明:修改区服服务当前时间用于QA测试
|
|
- 请求地址:{IP}:{port}/modifyopentime
|
|
- 请求参数:offest(请求时间戳|签名),sign(签名)
|
|
- 请求样例
|
|
```
|
|
{
|
|
"offest":12,
|
|
"sign":"asjioqiowjeioqjweijqwejoi"
|
|
}
|
|
```
|
|
- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
|
|
- 返回样例
|
|
```
|
|
{
|
|
"code":0,
|
|
"msg":"成功",
|
|
"data":"",
|
|
}
|
|
```
|
|
|
|
### 活动通知API
|
|
- 接口名:activitynotify
|
|
- 接口说明:web 服务器给玩家发送邮件
|
|
- 请求地址:{IP}:{port}/activitynotify
|
|
- 请求参数:id()
|
|
- 请求样例
|
|
```
|
|
{
|
|
"id":"64ca0a83510317d1896f06d7",
|
|
|
|
}
|
|
```
|
|
- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
|
|
- 返回样例
|
|
```
|
|
{
|
|
"code":0,
|
|
"msg":"成功",
|
|
"data":"",
|
|
}
|
|
```
|
|
|
|
### 账号封禁API
|
|
- 接口名:accountbannotify
|
|
- 接口说明:web 服务器给玩家发送邮件
|
|
- 请求地址:{IP}:{port}/accountbannotify
|
|
- 请求参数:uid:玩家账号 itype:封禁类型 (0 封号 1 禁言) value :状态(0 解封 1 封禁)
|
|
- 请求样例
|
|
```
|
|
{
|
|
"uid":"dfmxf_654b54f01fce80870e761e91",
|
|
"itype":0,
|
|
"value":1
|
|
}
|
|
```
|
|
- 返回参数 code(0:成功 -1 失败),msg(结果描述),data(返回的额外数据)
|
|
- 返回样例
|
|
```
|
|
{
|
|
"code":0,
|
|
"msg":"成功",
|
|
"data":"",
|
|
}
|
|
``` |