API 介绍

CNB OpenAPI 提供了一套完整的 RESTful API，用于访问和管理 CNB 云原生构建平台的各种资源。

基本信息

• API 基础 URL: https://api.cnb.cool
• 认证方式: Bearer Token
• 数据格式: application/vnd.cnb.api+json

认证

所有 API 请求都需要在请求头中包含认证令牌：

Authorization: Bearer YOUR_ACCESS_TOKEN

权限系统

CNB API 使用基于权限的访问控制，每个接口都需要特定的权限：

主要功能模块

组织管理 (Organizations)

• 创建、更新、删除组织
• 管理组织成员和权限
• 查询组织信息

仓库管理 (Repositories)

• 搜索公开仓库
• 管理用户仓库
• Star 功能

用户管理 (Users)

• 获取用户信息
• 管理用户资料
• 邮箱和 GPG 密钥管理

工作空间 (Workspace)

• 创建和管理云原生开发环境
• 启动、停止工作空间

搜索功能 (Search)

• 搜索公开仓库
• 支持多种过滤和排序选项

错误处理

API 返回标准化的错误响应：

{
  "error": {
    "code": "ERROR_CODE",
    "message": "错误描述信息"
  }
}

速率限制

API 请求可能受到速率限制，请在应用中实现适当的重试机制。