API使用说明
1 环境准备
2 基本使用步骤
3 请求方式说明
3.1 调用格式
1.
1.
URL: http://ip:port/unico/v1/node/open-detail
Method:get
Query:
{
"nodeId": 1
}
Response:
{
"code": 0,
"message": "ok",
"data": {
"sn": "1231231042541226",
"startTime": "1718282915976" }
}
2.
var Secret = []byte("whatasecret") //客户端通过调用UServer新增的节点信息接口,获取到的服务启动时间作为秘钥
// jwt过期时间, 按照实际环境设置
const expiration = 2 * time.Minute
type Claims struct {
// 自定义字段, 可以存在用户名, 用户ID, 用户角色等等
SN string
// jwt.StandardClaims包含了官方定义的字段
jwt.StandardClaims
}
func GetToken(SN string) (string, error) {
// 创建声明
a := &Claims{
SN: SN(open-detail接口返回的sn值),
StandardClaims: jwt.StandardClaims{
ExpiresAt: time.Now().Add(expiration).Unix(), // 过期时间
IssuedAt: time.Now().Unix(), // 签发时间
Issuer: "gin-jwt-demo", // 签发者
Id: "", // 按需求选这个, 有些实现中, 会控制这个ID是不是在黑/白名单来判断是否还有效
NotBefore: 0, // 生效起始时间
Subject: "", // 主题
},
}
// 用指定的哈希方法创建签名对象
tt := jwt.NewWithClaims(jwt.SigningMethodHS256, a)
return tt.SignedString(Secret)
}
3.2 调用举例
以获取节点信息为例:
1、打开API调用工具
以设置图层Z序为例:
1、打开API工具后,将请求方式改为PUT请求,根据IP与端口构造URL,构造对应需要的json数据,下发接口信息,查看是否下发成功
以删除图层为例:
1、打开API工具后,将请求方式改为DELETE请求,根据IP与端口构造URL,构造对应需要的json数据,下发接口信息,查看是否下发成功
4 错误码
错误码 | 字段 | 描述 |
---|---|---|
0 | success | 成功 |
非0 | failed | 失败 |
修改于 2025-04-17 08:14:17