Chuyển đến nội dung chính

Giới thiệu

Đăng ký nhận thông báo và cập nhật liên quan đến sản phẩm.

Thêm thông tin về giao diện người dùng của mô-đun https://doc.oneentry.cloud/docs/category/events

🎯 Mô-đun này làm gì?​

Mô-đun Events cho phép bạn đăng ký người dùng nhận thông báo về sản phẩm - như một email khi sản phẩm có hàng trở lại, hoặc một thông báo khi giá giảm. Bạn cấu hình các sự kiện trong bảng điều khiển quản trị OneEntry; SDK quản lý ai đã đăng ký nhận thông báo gì.

Hãy coi đây như một hệ thống đăng ký sản phẩm - người dùng đăng ký nhận thông báo cho các sản phẩm (hoặc biểu mẫu) cụ thể và nhận thông báo khi có sự thay đổi.

🚀 Bắt đầu nhanh​

Khởi tạo mô-đun từ defineOneEntry:


const { Events } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Liệt kê các sự kiện có sẵn (công khai - không cần xác thực):

// Fetch all events configured in the admin panel.
const events = await Events.getAllEvents();

events.forEach((event) => {
  console.log(event);
});

Để đăng ký một người dùng cho một sự kiện sản phẩm, bạn phải được xác thực trước, sau đó gọi subscribeByMarker(marker, productId, langCode?):

// Requires an authorized user (see AuthProvider).
const ok = await Events.subscribeByMarker("product_price_change", 12345, "en_US");
console.log(ok); // true on success

✨ Khái niệm chính​

Sự kiện sản phẩm là gì?​

Một sự kiện sản phẩm là một thông báo được kích hoạt bởi sự thay đổi của một sản phẩm:

  • Kích hoạt - điều gì xảy ra với sản phẩm (ví dụ: "có hàng trở lại", "giá giảm")
  • Thông báo - những gì người đăng ký nhận được (email hoặc thông báo đẩy)
  • Người đăng ký - người dùng đã chọn nhận cập nhật cho sản phẩm này
  • Mẫu - nội dung thông điệp thông báo (được cấu hình trong bảng điều khiển quản trị)

Mô-đun cũng hỗ trợ sự kiện biểu mẫu: đăng ký / hủy đăng ký nhận thông báo liên quan đến việc gửi biểu mẫu với subscribeToForm / unsubscribeFromForm.

Kênh thông báo​

KênhMô tảTốt nhất cho
EmailGửi tin nhắn emailThông báo có hàng, giá giảm, bản tin
Thông báo đẩyThông báo trên di động/trình duyệtThông báo khẩn cấp, bán hàng chớp nhoáng

📋 Những điều bạn cần biết​

Các sự kiện được cấu hình trong bảng điều khiển quản trị​

Các kích hoạt, kênh và mẫu được thiết lập trong bảng điều khiển quản trị OneEntry. SDK không tạo sự kiện hoặc kích hoạt chúng một cách thủ công — các sự kiện tự động kích hoạt khi dữ liệu sản phẩm thay đổi. SDK chỉ dùng để liệt kê các sự kiện và quản lý đăng ký.

Xác thực​

getAllEvents() là công khai. Mỗi phương thức đăng ký (getAllSubscriptions, subscribeByMarker, unsubscribeByMarker, subscribeToForm, unsubscribeFromForm, getFormSubscriptions) cần một người dùng đã được xác thực — xem AuthProvider.

Biến mẫu​

Sử dụng các biến giữ chỗ trong các mẫu thông báo để bao gồm chi tiết sản phẩm như tên, giá và tình trạng sẵn có. Các mẫu được chỉnh sửa trong bảng điều khiển quản trị.

📊 Bảng tham khảo nhanh - Các phương thức phổ biến​

Phương thứcChức năng
getAllEvents()Lấy tất cả các sự kiện có sẵn
getAllSubscriptions() 🔐Lấy tất cả các đăng ký sản phẩm
subscribeByMarker() 🔐Đăng ký nhận thông báo sản phẩm theo mã
unsubscribeByMarker() 🔐Hủy đăng ký nhận thông báo sản phẩm theo mã
subscribeToForm() 🔐Đăng ký nhận thông báo sự kiện biểu mẫu theo mã
unsubscribeFromForm() 🔐Hủy đăng ký nhận thông báo sự kiện biểu mẫu theo mã
getFormSubscriptions() 🔐Lấy tất cả các đăng ký biểu mẫu

🔐 các phương thức yêu cầu xác thực người dùng — xem AuthProvider. getAllEvents() là công khai.

❓ Câu hỏi thường gặp (FAQ)​

Làm thế nào để tôi tạo hoặc chỉnh sửa sự kiện sản phẩm?​

Các sự kiện được tạo và cấu hình trong bảng điều khiển quản trị OneEntry (phần Sự kiện) — thiết lập các kích hoạt, kênh và mẫu ở đó, sau đó kích hoạt sự kiện. SDK chỉ liệt kê các sự kiện và quản lý các đăng ký.

Tôi có thể kích hoạt một sự kiện sản phẩm từ mã của mình không?​

Không. SDK không hỗ trợ kích hoạt thủ công — các sự kiện tự động kích hoạt dựa trên các kích hoạt được cấu hình trong OneEntry khi dữ liệu sản phẩm thay đổi.

Tại sao việc đăng ký lại thất bại với lỗi xác thực?​

Các phương thức đăng ký yêu cầu một người dùng đã được xác thực. Hãy xác thực trước qua mô-đun AuthProvider, sau đó gọi subscribeByMarker / subscribeToForm. getAllEvents() hoạt động mà không cần xác thực.

🎓 Thực hành tốt nhất​

  • Xác thực người dùng trước khi gọi bất kỳ phương thức đăng ký nào.
  • Sử dụng các mã sự kiện mô tả (ví dụ: product_back_in_stock, product_price_drop).
  • Luôn cung cấp một cách hủy đăng ký dễ dàng (unsubscribeByMarker / unsubscribeFromForm).
  • Xử lý lỗi đăng ký một cách nhẹ nhàng và kiểm tra hình dạng trả về IError.

🔗 Tài liệu liên quan​