软著一键生成接口API文档

本API提供了生成Web项目、App项目和微信小程序项目的功能，所有操作均需验证激活码。此外，还包括关键词生成、队列监控和订单状态查询等功能。

基础URL

https://api.webarcx.com

认证

大多数接口需要提供激活码进行验证，激活码请联系购买

API接口列表

1. 生成Web项目

根据提供的参数生成Web项目。

• URL: /api/generate

• 方法: POST

• 请求体:

  若需要25%分成，请一定填写invite字段

  {
    "activationCode": "string",      // 必填: 激活码
    "softVersionNumber": "string",    // 必填: 软件版本号
    "projectName": "string",          // 必填: 项目名称
    "projectReminder": "string",      // 必填: 项目说明/备注
    "mailbox": "string",              // 必填: 接收生成项目的邮箱
    "invite": "string",               // 可选: 邀请邮箱
  }

• 成功响应:

  {
    "code": 1,
    "msg": "生成中，请稍后查看邮箱",
    "data": []
  }

• 错误响应:

  {
    "code": 0,
    "msg": "激活码错误，12月24日前购买的激活码已失效，请凭旧激活码发邮件兑换新激活码",
    "data": []
  }

  {
    "code": 0,
    "msg": "激活码无效：请使用AI生成专属激活码",
    "data": []
  }

  {
    "code": 0,
    "msg": "已被使用",
    "data": []
  }

  {
    "code": 0,
    "msg": "该任务已在队列中，请稍后",
    "data": {"position": 3}
  }

  {
    "code": 0,
    "msg": "服务器错误，请联系790002517@qq.com",
    "data": []
  }

2. 生成App项目

根据提供的参数生成App项目。

• URL: /api/app/generate

• 方法: POST

• 请求体: 与 /api/generate 相同

• 响应: 与 /api/generate 相同

3. 生成微信小程序项目

根据提供的参数生成微信小程序项目。

• URL: /api/wechat/generate

• 方法: POST

• 请求体: 与 /api/generate 相同

• 响应: 与 /api/generate 相同

4. 为项目生成关键词

使用AI为项目名称生成关键词。

• URL: /api/keywordsGenerate

• 方法: POST

• 请求体:

  {
    "activationCode": "string",  // 必填: 激活码
    "projectName": "string"      // 必填: 项目名称
  }

• 成功响应:

  {   "code": 1,   "msg": "成功",   "data": [     // 生成的关键词数组   ] }

• 错误响应:

  {   "code": 0,   "msg": "请先填写激活码",   "data": [] }

  {   "code": 0,   "msg": "请先填写项目名称",   "data": [] }

  {   "code": 0,   "msg": "激活码错误，请购买激活码后再使用AI辅助",   "data": [] }

  {   "code": 0,   "msg": "激活码无效：请使用AI生成专属激活码",   "data": [] }

  {   "code": 0,   "msg": "已被使用",   "data": [] }

  {   "code": 0,   "msg": "服务器错误，请重试",   "data": [] }

5. 检查队列状态

检查当前处理队列的状态。

• URL: /api/queueCheck

• 方法: GET

• 成功响应:

  {   "code": 1,   "msg": "现在队列空闲",   "data": [] }

• 队列忙碌响应:

  {   "code": 0,   "msg": "前方共 5 个任务正在处理中，请注意！",   "data": [] }

6. 查询订单状态

查询与激活码关联的订单状态。

• URL: /api/queryOrderStatus

• 方法: POST

• 请求体:

  {   "activationCode": "string"  // 必填: 激活码 }

• 成功响应:

  {   "code": 1,   "msg": "查询成功",   "data": [     // 订单详情数组   ] }

7. 查询队列位置

查询任务在处理队列中的位置。

• URL: /api/queryQueuePosition

• 方法: POST

• 请求体:

  {   "activationCode": "string"  // 必填: 激活码 }

• 成功响应:

  {   "code": 1,   "msg": "查询成功",   "data": {     "position": 3  // 队列中的位置   } }

• 错误响应:

  {   "code": 0,   "msg": "任务未找到",   "data": {} }

错误处理

所有接口返回标准格式的响应:

• code: 1表示成功，0表示失败

• msg: 描述结果的可读消息

• data: 响应数据，根据接口不同而变化

任务处理

• 任务在队列中异步处理

• 任务超时设置为1200秒（20分钟）

• 任务完成或失败时发送邮件通知

• 生成的文件将发送到提供的邮箱地址