1. Project
One Push
  • Tổng Quan
  • Bussiness Logic
    • ĐẶC TẢ KỸ THUẬT: HỆ THỐNG ĐIỀU PHỐI TIN NHẮN (PUSH ENGINE)
    • ĐẶC TẢ KỸ THUẬT: HỆ THỐNG ĐỒNG BỘ HEARTBEAT (REAL-TIME SYNC)
    • ĐẶC TẢ KỸ THUẬT: HỆ THỐNG ĐIỀU PHỐI TIN NHẮN (PUSH ENGINE)
    • Business Logic (Luồng Logic Nghiệp Vụ)
  • Project
    • API
      • Hướng dẫn sử dụng
        • 1.1 Khởi tạo Website Tham gia
        • 1.2 Cấu hình Bots Telegram
        • 1.3 Quản lý Chiến dịch (Campaigns)
        • 1.4 Lên Lịch Gửi Tự Động
        • 1.5 Tương tác & Thống kê
        • 1.6 Quản lý Tài khoản (RBAC)
        • 1.7 Báo cáo Chi tiết Tin nhắn (Web & Telegram)
      • Architecture
        • System Architecture (Kiến trúc Hệ thống)
        • Code Structure
        • Database Schema (Mô hình Dữ liệu)
      • Deployment
        • Local
        • Production
        • Development
      • API
        • Widget nhúng Website
          • Đăng ký Subscriber mới / Nhật ký Heartbeat
          • Cập nhật trạng thái Seen/Read
          • Ghi nhận hiển thị Alert Popup
          • Lấy dữ liệu Alert cho website
        • Tracking & Tương tác
          • Ghi nhận lựa chọn Yes/No
        • Báo cáo & Thống kê
          • Thống kê người dùng Real-time
          • Phân tích tăng trưởng Subscriber
          • Dữ liệu bản đồ nhiệt Vị trí
          • Xuất báo cáo thông báo Excel
        • Lịch gửi Thông báo
          • Danh sách lịch gửi thông báo
          • Tạo lịch gửi mới
          • Bật/Tắt lịch gửi
        • Betting Tips
          • Lấy Tip bóng đá HOT nhất
          • Lấy dữ liệu Mock Tip (Test)
        • Telegram Integration
          • Danh sách Telegram Bot
          • Telegram Webhook Endpoint
        • Email Marketing
          • Tạo và gửi chiến dịch Email
        • Hệ thống & RBAC
          • Danh sách tài khoản Admin/Nhân viên
          • Danh sách vai trò (Roles)
        • Tiện ích & Files
          • Truy xuất nhật ký hệ thống (System Logs)
        • Chiến dịch (Campaigns)
          • Danh sách chiến dịch
        • Website Khách hàng (Clients)
          • Danh sách website khách hàng
        • Quản lý Thành viên (Subscribers)
          • Danh sách người đăng ký (Subscribers)
          • Xóa người nhận tin
    • TOOL
      • Hướng dẫn sử dụng
        • Hướng dẫn sử dụng — Novu Notification Infrastructure
      • Architecture
        • System Architecture
        • Code Structure
        • Database Schema
      • Deployment
        • Deployment
      • API
        • 👥 Subscribers
          • Tạo/Cập nhật Subscriber
          • Cập nhật Profile
        • 🗺️ Workflows
          • Lấy danh sách Workflow Templates
          • Chi tiết Workflow
        • 📂 Notification History
          • Lịch sử biến động Notification
        • 🎯 Topics
          • Tạo Topic mới
        • 📐 Layouts
          • Lấy danh sách Layout (Email/Web)
        • 💬 Messages
          • Tra cứu vết tin nhắn chi tiết (Low-level)
        • 🔌 Integrations
          • Danh sách nhà cung cấp (Providers)
        • 🚀 Events & Triggers
          • Kích hoạt thông báo (Workflows)
          • Kích hoạt hàng loạt (Bulk Trigger)
  • Schemas
    • GenericResponse
  1. Project

2. API Interface

2. API Interface (Tiêu chuẩn Giao tiếp Public)#

Tài liệu này cung cấp chi tiết kỹ thuật cho các đầu API công khai (Public) dành cho bộ Widget nhúng trên Website khách hàng và các nền tảng tích hợp bên thứ ba.

MỤC LỤC#

1.
I. Nguyên tắc Chung & Quy chuẩn Response
2.
II. Phân hệ Widget nhúng (Public Widget APIs)
1. Lấy cấu hình Widget (/getAlert)
2. Ghi nhận Hiển thị (/widgets/messages/loadAlertPop)
3. Cập nhật Đã xem/đọc (/widgets/messages/readSeen)
3.
III. Phân hệ Tương tác & Sự kiện (Tracking)
1. Thực thi lựa chọn Yes/No (/api/tracking/choice)
4.
IV. Phân hệ Tích hợp Telegram (Webhooks)

I. Nguyên tắc Chung & Quy chuẩn Response#

Toàn bộ hệ thống giao tiếp thông qua RESTful API, định dạng dữ liệu trả về là JSON.
Ví dụ Response thành công:
{
  "success": true,
  "message": "Thao tác thành công",
  "data": { ... }
}
Cơ chế Xác thực (Auth):
Mọi Request công khai đều yêu cầu tham số token (Client Token) được đính kèm trong Body hoặc Query String để xác định nguồn gốc Website.

II. Phân hệ Widget nhúng (Public Widget APIs)#

1. Lấy cấu hình Widget linh hoạt#

API này được Widget gọi ngay khi trang web tải xong để lấy các thông số hiển thị (màu sắc, tiêu đề, nội dung popup).
Endpoint
POST /getAlert
Tham số Body (Request Body)
Tham sốKiểuBắt buộcMô tả
tokenstringCóClient Token định danh website khách
Dữ liệu phản hồi (Response Sample)
{
  "success": true,
  "data": {
    "title": "Khuyến mãi cực khủng",
    "content": "Đăng ký nhận ngay 100% giá trị nạp",
    "btn_text": "Tham gia",
    "expired": 3600
  }
}

2. Ghi nhận lựa chọn khảo sát (Yes/No)#

Dùng để theo dõi hành vi người dùng khi họ nhấn vào các nút tương tác trên thông báo.
Endpoint
POST /api/tracking/choice
Tham số Query (Query Parameters)
Tham sốKiểuBắt buộcMô tả
actionstringCóGiá trị là yes hoặc no
Tham số Body (Request Body)
Tham sốKiểuBắt buộcMô tả
tokenstringCóClient Token định danh
schedule_idintegerCóID của Lịch gửi (Schedule)
Kết quả trả về
{
  "success": true,
  "message": "Ghi nhận thành công"
}

III. Phân hệ Tương tác & Sự kiện (Tracking)#

1. Thực thi lựa chọn Yes/No#

Ghi nhận khảo sát khi người dùng tương tác với bộ nút "Đồng ý/Từ chối" trên trình duyệt.
Endpoint
POST /api/tracking/choice
Tham số Query Parameters
Tham sốKiểuBắt buộcMô tả
actionstringCóGiá trị yes hoặc no
Tham số Request Body
Tham sốKiểuBắt buộcMô tả
tokenstringCóClient Token
schedule_idintegerCóID của Lịch gửi tương ứng

IV. Phân hệ Tích hợp Telegram (Webhooks)#

Telegram Webhook Receiver#

Endpoint tiếp nhận tin nhắn từ Server Telegram khi người dùng tương tác với Bot.
Endpoint
POST /{token}/webhook
Tham số Path Parameters
Tham sốKiểuBắt buộcMô tả
tokenstringCóAPI Token định danh Bot Telegram
Nghiệp vụ xử lý
API này xử lý định dạng JSON chuẩn của Telegram (Update Object) để tự động hóa việc đăng ký Subscriber mới.
Modified at 2026-03-27 03:49:16
Previous
Business Logic (Luồng Logic Nghiệp Vụ)
Next
1.1 Khởi tạo Website Tham gia
Built with