1. API
Social Tool Documentation
  • Tổng quan
  • Bussiness | Logic
    • Bussiness | Logic
  • Project
    • ADMIN
      • Tổng quan ADMIN
      • Architecture
        • System architecture
        • Code structure
      • Deployment
        • Local
        • Staging
        • Product
      • Hướng dẫn sử dụng
        • Đăng nhập
        • FAQ
        • Mạng xã hội
          • Tài khoản mạng xã hội
          • Nội dung bài viết & bình luận
          • Quản lý liên kết
          • Thư viện hình ảnh
          • Thu thập dữ liệu
        • Hệ thống
          • Quản lý proxy
        • Chiến dịch
          • Tạo & quản lý chiến dịch
          • Đăng nhập tài khoản
          • Check Proxy
          • Join Group
    • API
      • Tổng quan API
      • Architecture
        • System architecture
        • Database schema
        • Code structure
      • Deployment
        • Local
        • Staging
        • Product
      • API Interface
        • 🔑 Identity & Session
          • List users
          • Create user
          • Update info user
          • Update info user
          • List user departments
          • Delete user
          • List user's AI keys
          • Create AI key
          • Get user's active API key
          • Get supported services
          • Get supported AI models
          • Update AI key
          • Delete AI key
          • Get AI key by ID
          • List departments
          • Create department
          • Update department
          • Create department
          • Update department
          • Update department roles
          • Get department roles
          • Update department status
          • Delete department
          • List user sessions
          • Create user session
          • Delete user session
          • Get user sessions by user ID
          • Delete all user sessions
          • Update user session status
          • List user activity logs
          • Create user activity log
          • Get user activity logs
          • Delete user activity logs
          • User login
          • User registration
          • User logout
          • Logout from all devices
          • Refresh access token
          • Create api key
          • Reset password
          • Get current user
          • Get user roles
          • Create role
          • Update role
          • Update role
          • Update role
          • List user permission groups
          • Get user permission group by ID
          • Delete user permission group
          • Create user permission group
          • Update user permission group
          • Get all user permission groups with permissions
        • 🛰️ Proxy & Connectivity
          • List proxies
          • Create proxy
          • Create many proxies
          • Update proxy
          • Delete proxy
          • Get proxy by ID
          • Import proxies from CSV/Excel
          • Check expired proxies
          • Kiểm tra proxy (qua Campaign)
          • Xóa proxy
          • Cập nhật proxy
          • Proxy Group list
          • Create a Proxy Group
          • Get a Proxy Group by ID
          • Update a Proxy Group
          • Delete a Proxy Group
          • Delete a Proxy Group
          • List proxy providers
          • Create proxy provider
          • Update proxy provider
          • Delete proxy provider
          • Get proxy provider by ID
          • Import proxy packages from CSV
          • List proxy packages
          • Create proxy package
          • Update proxy package
          • Delete proxy package
          • Get proxy package by ID
          • Import proxy packages from CSV
        • 📱 Social Management
          • List socials
          • Create social
          • Update social
          • Delete social
          • Get social by ID
          • List social accounts
          • Create social account
          • Create social account
          • Get account tasks
          • Assign proxies to social account
          • Update social account
          • Delete social account
          • Get social account by ID
          • Join social account
          • Cancel social accounts
          • Cancel social accounts
          • Import social accounts from file
          • Get account usage statistics
          • Push cookies manually for specific accounts (via Campaign)
          • Đổi tên nhiều tài khoản (qua Campaign)
          • Đổi mật khẩu nhiều tài khoản (qua Campaign)
          • Đổi ảnh đại diện (qua Campaign)
          • Social Account Group list
          • Create a Social Account Group
          • Get a Social Account Group by ID
          • Create a Social Account Group
          • Delete a Social Account Group
          • List social pages
          • Create social page
          • Update social page
          • Delete social page
          • Get social page by ID
          • Batch update social page status
          • Batch delete social pages
          • Import social pages from file
          • Search social pages
          • Batch delete social pages
          • Social Page Group list
          • Create a Social Page Group
          • Get a Social Page Group by ID
          • Update a Social Page Group
          • Delete a Social Page Group
          • List social actions
          • Create social action
          • Update social type
          • Delete social action
          • Get social type by ID
          • List social pages
          • Create social content
          • Update social content
          • Delete social content
          • Get social content by ID
          • Batch delete social content
          • Import social accounts from file
          • Create a new social content group
          • Get paginated list of social content groups
          • Get social content group by ID
          • Update social content group
          • Soft delete social content group
          • Batch delete social content groups
          • Delete social content group
          • Get groups by social platform ID
          • Social Image list
          • Create a Social Image
          • Get a Social Image by ID
          • Update a Social Image
          • Delete a Social Image
          • Social Collect Data list
          • Create a Social Collect Data
          • Get a Social Collect Data by ID
        • 📁 Campaign Management
          • List campaigns
          • Create campaign
          • Update campaign
          • Delete campaign
          • Get campaign by ID
          • Create campaign platform
          • List campaign platforms
          • Update campaign platform
          • Delete campaign platform
          • Get campaign platform by ID
          • Create campaign platform
          • Create campaign platform
          • Clone campaign platforms
          • Cancel multiple campaign platforms
          • List campaign joins
          • Create campaign platform
          • List campaign joins
          • Update campaign platform
          • Update campaign platform
          • Update campaign platform
          • Update campaign platform
          • List jobs
          • Update job
          • Delete job
          • Get job by ID
          • List campaign platform tasks
          • Create campaign platform task
          • Update campaign platform task
          • Delete campaign platform task
          • Get campaign platform job task by ID
          • List Report Categories
          • Create Report Categories
          • Create Report Categories
          • Create Report Categories
          • List Report Details
          • Create Report Details
          • Create Report Details
          • Create Report Details
    • TOOL
      • Tổng quan TOOL
      • Architecture
        • Database schema
        • System architecture
        • Code structure
      • Deployment
        • Local
        • Staging
        • Product
      • API Interface
        • 🎯 NATS — Task
          • [NATS RPC] Tạo batch Task mới
          • [NATS RPC] Lấy danh sách tất cả Tasks
          • [NATS RPC] Đếm số Task đang chờ xử lý
          • [NATS RPC] Xóa tất cả Tasks
        • 🍪 NATS — Cookie
          • [NATS RPC] Thêm batch Cookie (Auto Login)
          • [NATS RPC] Lấy danh sách tất cả Cookies
          • [NATS RPC] Xóa tất cả Cookies
        • 🌐 NATS — Proxy
          • [NATS RPC] Gửi batch Proxy để kiểm tra
        • 🔗 NATS — TaskJoin
          • [NATS RPC] Tạo lệnh tham gia Group
          • [NATS RPC] Kiểm tra trạng thái tham gia Group
        • 📤 NATS — Callbacks
          • [NATS PUB] Kết quả thực thi Task
          • [NATS PUB] Kết quả Crawl dữ liệu
          • [NATS PUB] Kết quả Auto Login
          • [NATS PUB] Kết quả kiểm tra Proxy
          • [NATS PUB] Kết quả tham gia Group
          • [NATS PUB] Kết quả kiểm tra trạng thái tham gia
        • 📊 HTTP — Logs & Info
          • Service Root — Thông tin Worker
          • Health Check
          • Đọc file log
          • Log hôm nay
          • Log theo ngày cụ thể
          • Danh sách ngày có log
          • Test kết nối ChatGPT
        • 📋 HTTP — Data Query
          • Danh sách Tasks (phân trang + lọc)
          • Xóa tất cả Tasks
          • Danh sách tất cả Cookies
          • Xóa tất cả Cookies
          • Xóa Cookie theo _id
          • Danh sách Proxies (lọc theo task_id)
          • Xóa tất cả Proxies
          • Proxy Checks đang chờ xử lý
          • Proxy Checks đã hoàn thành
          • Xóa Proxy theo _id
          • Danh sách Task Join (phân trang + lọc)
          • Tạo Task Join (HTTP mode)
          • Xóa tất cả Task Join
  • Schemas
    • AIInfo
    • CommentInfo
    • ReplyInfo
    • ShareInfo
    • CaptchaInfo
    • PageInfo
    • SocialAccountInfo
    • ProxyInfo
    • SocialInfo
    • ActionInfo
    • CreateTaskPayload
    • CreateCookiePayload
    • CreateProxyPayload
    • CreateTaskJoinPayload
    • NatsAcceptedResponse
    • NatsRejectedResponse
    • NatsErrorResponse
    • TaskCompletedPayload
    • CookieUpdatePayload
    • ProxyCheckResultPayload
    • TaskJoinResultPayload
    • TaskJoinCheckResultPayload
    • PagingInfo
    • AppError
  1. API

Tổng quan API

Social Tool API — Tổng quan hệ thống#

Tài liệu mô tả kiến trúc API của Social Tool, bao gồm cách xác thực, các module nghiệp vụ chính và quy trình tự động hóa chiến dịch. Toàn bộ API tuân theo chuẩn RESTful và bảo mật bằng JWT.

1. Thông tin chung#

Base URLhttp://<domain>:<port>/api
Swaggerhttp://<domain>:<port>/swagger
FrameworkElysiaJS (Bun runtime)
DatabaseMySQL + Drizzle ORM
Múi giờ lưu trữUTC+0
Lưu ý múi giờ: Các chuỗi ngày tháng không kèm timezone (ví dụ 2026-03-22 08:48:00) sẽ được hệ thống hiểu mặc định là UTC+7 (giờ Việt Nam) trước khi chuyển đổi và lưu về UTC+0.

2. Xác thực truy cập#

Tất cả endpoint đều yêu cầu Bearer Token, ngoại trừ login và signup.
Authorization: Bearer <your_jwt_token>
Để lấy token, gọi POST /api/auth/login với thông tin đăng nhập. Token trả về được đính kèm vào header của mọi request tiếp theo.

3. Các chức năng chính#

A. Chiến dịch#

Đây là module cốt lõi, quản lý toàn bộ kịch bản tương tác đa kênh theo ba tầng:
Campaign — Chiến dịch chính, bao gồm tên và loại mạng xã hội.
Campaign Platform — Cấu hình chi tiết cho từng hành động (Like, Comment, Share), lưu trữ danh sách link/tài khoản mục tiêu (metadata_json) và quy tắc thực thi (rules_json: thời gian, số lượng, giới hạn).
Campaign Platform Task — Các tác vụ do hệ thống tự sinh ra từ cấu hình Platform và cronjob, mỗi task tương ứng với một hành động cụ thể trên một tài khoản cụ thể.
Endpoint tham khảo:
MethodEndpointMô tả
GET/api/campaignsDanh sách chiến dịch
POST/api/campaign-platformsTạo cấu hình chạy
GET/api/campaign-platform-tasksTheo dõi trạng thái task

B. Tài khoản & Trang mạng xã hội#

Social Account — Tài khoản mạng xã hội (Facebook, TikTok…) được dùng để thực hiện các thao tác tương tác.
Social Page — Link bài viết, fanpage hoặc profile là đích đến của các hành động tương tác.
Social Content — Nội dung cần post/share/comment trên từng link (Có thể nội dung đã tạo sẵn hoặc do AI tự gen ra)
Endpoint tham khảo:
MethodEndpointMô tả
GET/api/social-accountsQuản lý tài khoản theo nhóm hoặc riêng lẻ
POST/api/social-pagesThêm và phân loại link mục tiêu

C. Hệ thống#

Server — Là những con server chứa tool để thực hiện task.
Proxy — Quản lý xoay vòng proxy tự động, bảo vệ tài khoản khỏi bị phát hiện hoặc khoá.

4. Định dạng dữ liệu#

Request: Sử dụng application/json. Định dạng ngày tháng khuyến nghị: YYYY-MM-DD HH:mm:ss.
Response: Mọi phản hồi đều theo cấu trúc thống nhất:
{
  "data": { ... },
  "message": "Success",
  "status": 200
}

5. Quy trình tự động hóa#

[1] Người dùng tạo Campaign Platform
       metadata_json (links) (thời gian, số lượng)
              │
              ▼
[2] Cron-job quét Platform có trạng thái pending
              │
              ▼
[3] Hệ thống sinh Campaign Platform Tasks
       Chia nhỏ theo cấu hình metadata & start_date
              │
              ▼
[4] Tasks được gán → Server + Account + Proxy + Content khả dụng
              │
              ▼
[5] Cập nhật trạng thái thời gian thực
       Processing → Completed / Failed
Modified at 2026-03-30 09:47:57
Previous
Join Group
Next
System architecture
Built with