Mô-đun khởi tạo hệ thống

Nên sử dụng HTTPS trong môi trường sản xuất để bảo mật mã thông báo xác thực. HTTP chỉ được khuyến nghị cho môi trường phát triển.

Mô-đun khởi tạo hệ thống chịu trách nhiệm cấu hình triển khai lần đầu và giám sát trạng thái vận hành. Nó hỗ trợ cơ sở dữ liệu SQLite, MySQL và PostgreSQL, bao gồm tạo người dùng Root và khởi tạo tham số hệ thống. Giao diện trạng thái cung cấp thông tin hệ thống theo thời gian thực, bao gồm cấu hình OAuth, chuyển đổi tính năng, v.v.

🔐 Không cần xác thực

Nhận trạng thái khởi tạo hệ thống

• Tên giao diện: Nhận trạng thái khởi tạo hệ thống
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/setup
• Yêu cầu xác thực: Công khai
• Tóm tắt tính năng: Kiểm tra xem quá trình khởi tạo hệ thống đã hoàn tất hay chưa, truy xuất loại cơ sở dữ liệu và trạng thái người dùng Root

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/setup', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "data": {
    "status": false,
    "root_init": true,
    "database_type": "sqlite"
  }
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "System error"
}

🧾 Mô tả trường:

• status (Boolean): Quá trình khởi tạo hệ thống đã hoàn tất chưa
• root_init (Boolean): Người dùng Root có tồn tại hay không
• database_type (String): Kiểu cơ sở dữ liệu, giá trị tùy chọn: "mysql", "postgres", "sqlite"

Hoàn thành Trình hướng dẫn cài đặt lần đầu

• Tên giao diện: Hoàn thành trình hướng dẫn cài đặt lần đầu
• Phương thức HTTP: POST
• Đường dẫn: /api/setup
• Yêu cầu xác thực: Công khai
• Tóm tắt tính năng: Tạo tài khoản quản trị viên gốc và hoàn tất cấu hình khởi tạo hệ thống

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/setup', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    username: "admin",
    password: "password123",
    confirmPassword: "password123",
    SelfUseModeEnabled: false,
    DemoSiteEnabled: false
  })
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "message": "System initialization completed"
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Username length cannot exceed12characters"
}

🧾 Mô tả trường:

• username (String): Tên người dùng quản trị viên, độ dài tối đa 12 ký tự
• password (String): Mật khẩu quản trị viên, tối thiểu 8 ký tự
• confirmPassword (String): Xác nhận mật khẩu, phải trùng với mật khẩu
• SelfUseModeEnabled (Boolean): Có bật Chế độ Tự sử dụng hay không
• DemoSiteEnabled (Boolean): Có bật Chế độ trang demo hay không

Nhận tóm tắt trạng thái hoạt động

• Tên giao diện: Nhận tóm tắt trạng thái hoạt động
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/status
• Yêu cầu xác thực: Công khai
• Tóm tắt tính năng: Truy xuất trạng thái hoạt động của hệ thống, thông tin cấu hình và trạng thái chuyển đổi tính năng

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/status', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "message": "",
  "data": {
    "version": "v1.0.0",
    "start_time": 1640995200,
    "email_verification": false,
    "github_oauth": true,
    "github_client_id": "your_client_id",
    "system_name": "88API",
    "quota_per_unit": 500000,
    "display_in_currency": true,
    "enable_drawing": true,
    "enable_task": true,
    "setup": true
  }
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Failed to get status"
}

🧾 Mô tả trường:

• version (String): Số phiên bản hệ thống
• start_time (Number): Dấu thời gian khởi động hệ thống
• email_verification (Boolean): Xác minh email có được kích hoạt hay không
• github_oauth (Boolean): Đăng nhập GitHub OAuth có được bật hay không
• github_client_id (Chuỗi): ID khách hàng GitHub OAuth
• system_name (String): Tên hệ thống
• quota_per_unit (Number): Lượng định mức trên một đơn vị
• display_in_currency (Boolean): Có hiển thị dưới dạng tiền tệ hay không
• enable_drawing (Boolean): Chức năng vẽ có được bật hay không
• enable_task (Boolean): Chức năng tác vụ có được bật hay không
• setup (Boolean): Quá trình khởi tạo hệ thống đã hoàn tất chưa

Đầu dò trạng thái tương thích Uptime-Kuma

• Tên giao diện: Đầu dò trạng thái tương thích Uptime-Kuma
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/uptime/status
• Yêu cầu xác thực: Công khai
• Tóm tắt tính năng: Cung cấp giao diện kiểm tra trạng thái tương thích với hệ thống giám sát Uptime-Kuma

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/uptime/status', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "data": [
    {
      "categoryName": "OpenAIServe",
      "monitors": [
        {
          "name": "GPT-4",
          "group": "OpenAI",
          "status": 1,
          "uptime": 99.5
        }
      ]
    }
  ]
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Failed to obtain monitoring data"
}

🧾 Mô tả trường:

• categoryName (String): Tên danh mục giám sát
• monitors (Array): Danh sách các mục giám sát
• name (String): Tên mục theo dõi
• group (String): Tên nhóm giám sát
• status (Số): Mã trạng thái, 1=Bình thường, 0=Bất thường
• uptime (Số): Phần trăm thời gian hoạt động

🔐 Xác thực quản trị viên

Kiểm tra các thành phần phụ trợ và phụ thuộc

• Tên giao diện: Kiểm tra các thành phần phụ trợ và phụ thuộc
• Phương thức HTTP: NHẬN
• Đường dẫn: /api/status/test
• Yêu cầu xác thực: Quản trị viên
• Tóm tắt tính năng: Kiểm tra trạng thái kết nối và tình trạng của các thành phần hệ thống khác nhau

💡 Yêu cầu Ví dụ:

const response = await fetch('/api/status/test', {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer your_admin_token',
    'New-Api-User': 'your_user_id'
  }
});
const data = await response.json();

✅ Ví dụ phản hồi thành công:

{
  "success": true,
  "message": "All components tested passed",
  "data": {
    "database": "connected",
    "redis": "connected",
    "external_apis": "healthy"
  }
}

❗ Ví dụ về phản hồi thất bại:

{
  "success": false,
  "message": "Database connection failed"
}

🧾 Mô tả trường:

• database (String): Trạng thái kết nối cơ sở dữ liệu
• redis (String): Trạng thái kết nối Redis
• external_apis (String): Trạng thái sức khỏe API bên ngoài