API服务平台

自动构建API服务平台

服务状态

系统运行状态:正常

工作流服务

正常

管理CI/CD自动构建工作流

GETPOSTPUTDELETE

密钥管理

正常

管理API密钥和访问令牌

GETPOSTPUTDELETE

项目管理

正常

管理自动构建项目

GETPOSTPUTDELETE

密钥验证

正常

验证API密钥的有效性

POST

构建操作

正常

执行和管理CI/CD构建任务

GETPOST

订单支付

正常

创建和管理支付订单

GETPOST

支付回调

正常

处理支付平台的回调通知

POST

API接口文档

工作流服务

管理CI/CD自动构建工作流

方法路径说明
GET/api/workflow获取工作流列表,支持分页和名称过滤
GET/api/workflow/:id获取指定ID的工作流详情
POST/api/workflow创建新工作流
PUT/api/workflow/:id更新指定ID的工作流
DELETE/api/workflow/:id删除指定ID的工作流

密钥管理

管理API密钥和访问令牌

方法路径说明
GET/api/secret获取密钥列表,支持分页和名称过滤
GET/api/secret/:id获取指定ID的密钥详情(不返回值)
POST/api/secret创建新密钥
PUT/api/secret/:id更新指定ID的密钥
DELETE/api/secret/:id删除指定ID的密钥

项目管理

管理自动构建项目

方法路径说明
GET/api/project获取项目列表,支持分页和名称过滤
GET/api/project/:id获取指定ID的项目详情
POST/api/project创建新项目
PUT/api/project/:id更新指定ID的项目
DELETE/api/project/:id删除指定ID的项目

密钥验证

验证API密钥的有效性

方法路径说明
POST/api/validator验证密钥的有效性,检查过期状态和调用限制

构建操作

执行和管理CI/CD构建任务

方法路径说明
POST/api/actions触发新的构建任务,需要提供密钥和项目信息
GET/api/actions?run_id=xxx查询指定run_id的构建任务状态和下载链接

订单支付

创建和管理支付订单

方法路径说明
POST/api/order创建新的支付订单,支持月付和次数付费
GET/api/order/:id查询订单状态和详情

支付回调

处理支付平台的回调通知

方法路径说明
POST/api/payment/webhook接收支付平台回调,处理支付成功后的业务逻辑

API响应格式

{
  "code": 0,      // 状态码: 0成功,非0表示各种错误
  "message": "",    // 提示消息
  "data": {},       // 响应数据,可能是对象或数组
  "success": true,  // 请求是否成功
  "timestamp": 1679012345678,  // 时间戳
}

项目配置示例

// 项目配置示例 - 包含支付配置
{
  "id": 123,
  "name": "示例项目",
  "description": "这是一个示例项目",
  "pricing": {
    "monthly": 9.99,
    "per_use": 1.99
  },
  "payment_config": {
    "cryptomus": {
      "api_key": "你的API密钥",
      "merchant_id": "你的商户ID"
    }
  },
  // 其他项目配置...
}

订单支付示例

// 请求示例 - 创建订单
POST /api/order
{
  "project_id": 123,
  "order_type": "monthly", // 或 "per_use"
  "quantity": 3,           // 购买数量
  "return_url": "https://example.com/payment/success"
}

// 响应示例
{
  "code": 0,
  "message": "支付链接创建成功",
  "data": {
    "project_id": 123,
    "project_name": "示例项目",
    "order_type": "monthly",
    "quantity": 3,
    "unit_price": 9.99,
    "total_amount": 29.97,
    "payment_url": "https://pay.cryptomus.com/pay/xxxx",
    "payment_details": {
      "uuid": "d8e8fca2-dc0f-4e41-a4c5-xxxxx",
      "order_id": "123-monthly-1679012345678-1234",
      "status": "pending",
      "currencies": [...]
    }
  }
}