# 概述
随着插件的不断迭代更新，旧有的API模块（即直接执行萌化代码）已经不能满足需求。为了框架能够在多平台上处理，8.8044版本中推出了新API模块，通过更加人性化、高效的操作拓展本框架。
# API说明
## **接口地址**
API的接口地址均遵循统一格式
>[info] http:// IP地址 : 端口 /key = 设置的key
1. IP地址
若拥有公网IP，此处可以填写公网IP，即可做到远程调用插件API。
本示例以本机调用为例，即IP为**127.0.0.1**
2. 端口号
8044版本以前，插件没有端口判断机制，多个酷Q同时开启无法正常识别端口。在新版本中，插件会优先使用没有被占用的端口，可以在插件主窗口的实验室中查看插件正在使用的端口。
本示例默认使用端口8044
3. key
key即为用户在插件主窗口中填写的APIkey。本示例中key为**MHCustom**
通过上面的构造，此客户端的API调用地址即为**http://127.0.0.1:8044/key=MHCustom**
## **协议头**
为区分新旧API，使用新版API需在协议头中添加Version: 2
使用萌化代码即[设置附加协议Version: 2]
## **请求数据**
请求数据为Json格式，编码为UTF8，示例：
```json
{
"apiName":"getPluginList"
}
```
组合一下，使用插件的代码来写就是
>[info] [设置附加协议Version: 2][POST2http://127.0.0.1:8044/key=MHCustom；{"apiName":"getPluginList"}；]
## **返回数据**
| 参数 | 参数类型 | 参数说明 |
| --- | --- | --- |
| code | 整数 | 执行结果，0代表成功|
|msg|文本|仅当执行失败时存在该参数，返回错误信息|
|returnType|文本|array->数组，int->整数，string->文本|
|returnNum|整数|仅当returnType为array时存在，数组的长度|
|data|整数/文本/数组|相关数据|
不同接口的说明请参见左侧的列表
