Open API

• API 服务地址
• 访问令牌申请
• API 文档
• 调用方式
  • Header 头信息
  • 请求示例

API 服务地址

服务请求地址为 https://api.cnb.cool。

访问令牌申请

访问 个人设置 -> 访问令牌 -> 添加访问令牌，进入令牌创建页面。

令牌需要的配置参数如下:

• 令牌名: 令牌名称，用于唯一标识令牌。
• 到期时间: 令牌过期时间，过期后令牌不可用。
• 使用范围: 令牌使用范围，用于限制令牌访问的仓库类型。
• 授权范围: 令牌授权范围，授予令牌在账号下的可操作权限。访问 API 接口时，需要令牌满足接口的授权范围才能正常得到返回。
• 常见场景: 根据常见的使用场景，提供快速初始化令牌授权范围。

完成创建后，即可获取到令牌 token。

API 文档

API 文档地址 https://api.cnb.cool。

调用方式

Header 头信息

• Authorization， string类型，HTTP 标准身份认证头部字段，携带个人令牌进行检验，格式为: Bearer ${token}。

请求示例

curl 请求示例

curl -X "GET" "https://api.cnb.cool/user/groups?page=1&page_size=10" -H "accept: application/json" \
  -H "Authorization: Bearer 1Z1609lSrSizKnLxEWx6WLr3lvA"

返回示例

[
  {
    "id": 1816756487609032700,
    "name": "test",
    "remark": "测试组织",
    "description": "",
    "site": "",
    "email": "",
    "freeze": false,
    "wechat_mp": "hello-world",
    "created_at": "2024-07-26T08:44:35Z",
    "updated_at": "2024-08-13T07:32:13Z",
    "follow_count": 0,
    "member_count": 4,
    "all_member_count": 4,
    "sub_group_count": 5,
    "sub_repo_count": 7,
    "sub_mission_count": 1,
    "all_sub_group_count": 13,
    "all_sub_repo_count": 12,
    "all_sub_mission_count": 1,
    "has_sub_group": true,
    "path": "test",
    "access_role": "Owner"
  }
]