云端联合封禁开发文档

Ray 发表于 2019-04-06 13:25:48
编辑于 2019-04-06 13:25:48

# 云端联合封禁 开发文档

## 开始之前

开始之前，您应该准备两个常量，叫做`accessKeyID`和`accessKeySecret`。

您可以在[`https://panel.414c.cc/`](https://panel.414c.cc/ "`https://panel.414c.cc/`")申请以上数据用于开发。

**`accessKeySecret`应该加密保存，这用于获取临时`accessToken`时的重要凭证，可以访问您应用的所有内容。**

## 公共请求结构

### 请求地址

`https://414c.cc/api/`

### 请求方法

客户端请求时需向指定URL发起HTTPS POST请求，以`form-data`的方式发送指服务器端。

### 通信协议

为了获得更高的安全性，仅支持使用**`HTTPS`**协议发送请求。

### 请求参数

您需要在每个请求中指定公共请求参数和具体接口规定的请求参数。其中，API参数以`body`的方式传递，公共请求参数则通过`Params`传递。

### 字符编码

请求及返回结果都使用`UTF-8`字符集进行编码。

### 公共参数

公共参数总共有三个，如下表。

| 名称  | 类型  | 是否必选  | 示例值  | 描述  |
| ------------ | ------------ | ------------ | ------------ | ------------ |
| `action`  | string  | 真  | getList  | 表示请求的API，即各个API名称中“API/”后面的内容  |
| `accessKeyID`  | string  | 真  | ubc10001  | 您的应用AccessKeyID。  |
| `accessToken`  | string  | 真  | 24.ubc12a345b6789c  | 请见下文，[生成Token](#生成token "生成Token")  |

### 返回内容

返回内容固定以`json`进行编码。

## API/verifToken

API解释：提交`accessToken`，每个小时只能请求两次。

在调用API时公共参数中必须带上`accessToken`参数，安全起见，`accessToken`需要您自己在本地生成，服务器端不会回传予您`accessToken`，再提交给服务端进行保存验证，流程如下：

### 生成Token

Token是由AES加密后的一串文本串，加密前的文本串由您的`accessKeyID`与随机码组成，加密的密钥您的`accessKeySecret`。

#### 示例代码

以伪PHP为例，代码如下：

```php
<?php 
$accessKeyID = "ubc12345";
$accessKeySecret = "ubc123456789";
$rand = rand(1000000, 9999999);
function  AESEncrypt(val, key){
return();
}
$accessToken = AESEncrypt($accessKeyID.$rand,$accessKeySecret);
?>
```

### 请求参数

| 名称  | 类型  | 是否必选  | 示例值  | 描述  |
| ------------ | ------------ | ------------ | ------------ | ------------ |
| `whoIsNbBest`  | string  | 真  | Lxns  | 固定值  |

### 请求示例

```
POST https://414c.cc/api/?action=verifToken&accessKeyID=ubc12345&accessToken=ubc12a345b6789c HTTP/1.1
Accept: application/json
Content-Type: application/json
Date: Sat, 23 Feb 2019 16:25:36 GMT

{
"whoIsNbBest": "Lxns"
}
```

### 服务器返回

服务器返回的JSON文本参数如下：

- `code`：状态码；用来区分是成功还是失败；
- `expiresIn`： Access Token的有效期(秒为单位，一般为1小时)；
- `error`： 错误码；关于错误码的详细信息请参考下方鉴权认证错误码；
- `errorDescription`： 错误描述信息，帮助理解和解决发生的错误；
- 其他参数忽略，暂时不用;

`error`与`errorDescription`相关解释如下：

| error  | errorDescription  | 解释  |
| ------------ | ------------ | ------------ |
|  invalidClient | unknown client id  |  API Key不正确 |
|  invalidClient | Client authentication failed  |  Secret Key不正确 |
|  tmr | too many requests  | 1小时内最多获取两条Access Token(获取成功与失败都包括在内)  |
|  invalidAns |  Lxns is NB Best!! | whoIsNbBest不正确  |

若请求成功，返回例子如下：

```json
{
  "code": 100,
  "whoIsNbBest": "Lxns",
  "expiresIn": 3600,
  "poweredBy": "United Ban Cloud"
}
```

若请求失败，返回例子如下：

```json
{
  "code": 203,
  "error": "tmr",
  "errorDescription": "too many requests"
}
```

## API/search

API解释：查找指定数据是否在云联封列表中存在（精确查找）。

请注意在请求时带上相应的公共参数。

### 请求参数

| 名称  | 类型  | 是否必选  | 示例值  | 描述  |
| ------------ | ------------ | ------------ | ------------ | ------------ |
| `data`  | string  | 真  | 123456789  | 精确查找的内容  |
| `type`  | string  | 假  | QQ  | 查找的范围，空为全局，可选值为：QQ、MinecraftID、Domain、Time、Code  |

### 请求示例

```
POST https://414c.cc/api/?action=search&AccessKeyID=ubc12345&AccessToken=24.ubc12a345b6789c HTTP/1.1
Accept: application/json
Content-Type: application/json
Date: Sat, 23 Feb 2019 16:25:36 GMT

{
"data": "123456789"
}
```

### 服务器返回

服务器返回的JSON文本参数如下：

- `code`： 表示请求是否成功；
- `list`： 表示请求结果，json数组；
- `message`：请求出错时的错误信息；

其中list包含以下几个数据：

- `Code` : 封禁码；
- `QQ` : 被封禁QQ；
- `MinecraftID` : 被封禁的MC UUID；
- `Domain` : 被封禁的域名；
- `From` : 封禁来源；
- `Reason` : 封禁原因；
- `Time` : 封禁时间

返回示例1：

```json
{
    "code": 100,
    "list": [
        {
            "Code": "5vaw8A",
            "QQ": "210795003",
            "MinecraftID": null,
            "Domain": null,
            "From": "RAC",
            "Reason": "违规信息",
            "Time": "2019-01-13 15:00:00"
        }
    ]
}
```

返回示例2：

```json
{
    "code": 201,
    "message": "短时间内请求太多!"
}
```

## API/pushBan
### 请求参数
### 请求示例
### 服务器返回
## API/pushUnban
### 请求参数
### 请求示例
### 服务器返回

Ray

@Ray

勿忘初心，方得始终。

云端联合封禁开发文档

Ray

最新文章

评论

云端联合封禁 开发文档

Ray

archive最新文章

评论

云端联合封禁开发文档

最新文章