47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# sdlan web api文档
|
||
sdlan为前端提供了若干api。其中，所有的api都使用POST方法，将数据以json消息体的方式提交给服务端。服务端根据具体处理结果，返回json数据。
|
||
|
||
## 1. 返回消息体
|
||
sdlan api的所有返回的消息体都遵循如下格式：
|
||
|
||
```json
|
||
{
|
||
"code": $int,
|
||
"message": $object,
|
||
"error": $string,
|
||
}
|
||
```
|
||
|
||
其中，code为0代表请求成功，返回的内容存放在`message`字段，`error`字段为空字符串；反之，如果请求失败，则`code`不为0，同时，`message`为空字符串，`error`字段为错误描述字符串。
|
||
|
||
在后面的描述中，如果请求成功，则默认返回的`code`为0，`error`为空字符串，而`message`会写明结构；如果返回失败，则`message`为空字符串，`code`和`error`会根据情况标明。
|
||
|
||
## 2. 消息请求参数说明
|
||
在实际操作过程中，用户会需要先注册，注册成功之后，需要先使用用户名和密码进行登录，密码验证成功之后，后台会返回一个token，该token有效期为一个小时，在登录成功之后所有其他的接口（即除了register和login接口），在发起请求的时候，都需要在请求头的header里面带上`token`，否则会权限热症失败，返回`code`为400，`error`为`“unauthorized”`
|
||
|
||
## 3. 实际接口
|
||
实际接口分成几个类别列举。
|
||
|
||
### 4.1. 用户操作
|
||
用户操作包括用户注册，登录，登出，创建/删除/查看register-token(用于节点登录时填写的token);修改密码等一系列关于用于的操作。
|
||
|
||
### 4.2. 网络操作
|
||
网络操作主要包括网络的创建、列举、删除、路由（给网络添加、删除一系列路由信息）等操作。
|
||
|
||
### 4.3. 节点操作
|
||
节点操作包括对节点的授权、取消授权、在网络之间移动等操作。
|
||
|
||
#### 4.3.1 授权节点
|
||
该接口用于对未授权的节点进行授权操作。
|
||
|
||
```
|
||
POST /peer/authorize
|
||
|
||
HEADER: Token
|
||
|
||
BODY:
|
||
{
|
||
|
||
}
|
||
```
|