# 获取链接分组接口
# 请求
URL:https://api.xiaomark.com/v1/group/get
请求方式:POST
请求参数格式:JSON
1
2
3
2
3
# 请求参数说明
参数名 | 类型 | 是否必传 | 描述 |
---|---|---|---|
apikey | string | 是 | 用户的API密钥 |
# 请求POST数据示例
{
"apikey": "361f534e9897e75af4206ea820365fde"
}
1
2
3
2
3
可以在 API 设置 中查看、重置apikey。
# 返回参数说明
名称 | 类型 | 描述 |
---|---|---|
code | integer | 返回码 |
message | string | 错误信息 |
data | object | 请求成功返回的数据 |
groups | object数组 | 用户的链接分组,详见 分组信息 |
workspaces | object数组 | 用户创建或加入的协作空间,详见 空间信息 |
# 分组信息 groups
名称 | 类型 | 描述 |
---|---|---|
sid | string | sid |
name | string | 分组名称 |
n_links | integer | 该分组下的链接数量 |
# 空间信息 workspaces
名称 | 类型 | 描述 |
---|---|---|
name | string | 空间名称 |
role | string | 用户在该空间的角色(创建者为creator,协作者为collaborator) |
groups | object数组 | 该空间下的链接分组,详见 分组信息 |
# 返回结果示例
{
"code": 0,
"data": {
"groups": [
{
"n_links": 2,
"name": "默认分组",
"sid": "uu4dv4fb"
},
{
"n_links": 3,
"name": "分组1",
"sid": "w7ho5te8"
}
],
"workspaces": [
{
"groups": [
{
"n_links": 2,
"name": "默认分组",
"sid": "y8e32c4h"
},
],
"name": "我创建的空间",
"role": "creator"
},
{
"groups": [
{
"n_links": 2,
"name": "默认分组",
"sid": "6yif6uej"
},
{
"n_links": 12,
"name": "测试分组",
"sid": "z6edywtw"
},
],
"name": "我加入的空间",
"role": "collaborator",
}
]
},
"message": "请求成功",
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
← 使用说明 获取链接分组下的短链接接口 →