API接口概述
## 概述
>#### API接口概述：
由于目前市面上自动化工具较多，为了方便自动化工具接入，特意开放公共API以供自动开区工具使用，API接口是其他系统与本系统交互最方便的途径。
API接口请求方式只支持POST。
API接口请求全部按<font color="red">Api统一请求参数</font>组合成<font color="red">json格式</font>提交。
API接口地址默认为http://domain/api/request，合作方接入时，建议采用配置方式，避免由于不可变因素引起平台更换接口域名。
>#### Api统一请求参数
| 参数名 | 必填 | 类型 | 示例值| 描述|
| ---- | ---- |---- |---- |---- |
| version | 是 |String |1.0 |API接口的版本号 |
| userid | 是 |Int |80314 |平台的用户ID |
| type | 是 |String |grouplist |接口类型标识,详见各接口详情 |
| data | 是 |JsonArray |{groupid: 2,groupname: "默认分组一"} |接口数据包,json格式,参数列表见各接口参数详情 |
| sign | 是 |String |8b84049f19cd7e92bc55ad3c749b8770 |接口校验签名,32位小写md5串,详见签名规则 |
例如,获取分组列表-举例如下：
```json
{
"version": "1.0",
"userid": "80314",
"type": "grouplist",
"data": "",
"sign": "8b84049f19cd7e92bc55ad3c749b8770"
}
```
>#### 提交签名规则：
签名校验原串为:{version}{userid}{type}{apikey)
例如ApiKey为:d4195dc498ac0a2d64da7523f993aee9
如以上示例中组合为:1.080314grouplist<font color="red">d4195dc498ac0a2d64da7523f993aee9</font>
生成MD5签名为:8b84049f19cd7e92bc55ad3c749b8770
>#### Api统一返回参数
| 参数名 | 必填 | 类型 | 示例值| 描述|
| ---- | ---- |---- |---- |---- |
| code | 是 |Int|200 |请求状态代码,200:操作成功,201:业务失败,500:异常 |
| msg | 是 |String |分组获取成功 |请求状态说明,中文描述 |
| data | 是 |Json |{"groupid":2,"groupname":"默认分组"} |接口返回数据包,json格式,参数列表见各接口返回参数详情 |
| sign | 是 |String |0e79117a38833ef4d5f256b58136adc3 |接口校验签名,32位小写md5串,详见签名规则 |
举例如下：
```json
{
"code": 200,
"msg": "分组获取成功",
"data": [{
"groupid": 88,
"groupname": "默认分组一"
}, {
"groupid": 89,
"groupname": "默认分组二"
}],
"sign": "0e79117a38833ef4d5f256b58136adc3"
}
```
>#### APIKEY说明
获取方式：登录平台 -> 游戏管理 -> 通讯密钥。
由于接口权限较高，拥有删除分区、修改分区等功能，所以请保管好APIKEY，并经常更换，分组、分区等数据丢失后，无法找回。