Giới thiệu
Bán quyền truy cập vào sản phẩm của bạn dưới dạng đăng ký trả phí định kỳ.
🔐 Các phương thức của mô-đun này yêu cầu ủy quyền.
Thông tin thêm về giao diện người dùng của mô-đun https://doc.oneentry.cloud/docs/category/subscriptions
🎯 Mô-đun này làm gì?
Mô-đun Đăng ký cho phép bạn quản lý các đăng ký trả phí cho người dùng hiện tại — tạo một đăng ký và nhận một phiên thanh toán, hủy nó, khôi phục nó thông qua Cổng thanh toán Stripe, và liệt kê các dấu hiệu đăng ký có sẵn hoặc đang hoạt động.
Thay vì các đơn hàng một lần, người dùng đăng ký một gói (một dấu hiệu như premium) và được tính phí tự động bởi nhà cung cấp thanh toán.
🚀 Bắt đầu nhanh
Khởi tạo mô-đun từ defineOneEntry:
const { Subscriptions } = defineOneEntry( "your-project-url", { "token": "your-app-token" });
Đăng ký người dùng hiện tại vào một gói và chuyển hướng họ đến phiên thanh toán (cần xác thực):
// Create a subscription for the "premium" plan.
const session = await Subscriptions.subscribe({ marker: "premium" });
// Send the user to the payment page to complete the first payment.
window.location.href = session.paymentUrl;
✨ Khái niệm chính
Dấu hiệu đăng ký là gì?
Một dấu hiệu là định danh văn bản duy nhất của một gói đăng ký (ví dụ premium). Bạn truyền nó cho mọi phương thức của mô-đun này để cho OneEntry biết bạn đang nói đến gói nào. Các dấu hiệu không bao giờ thay đổi, vì vậy hãy luôn tham chiếu các gói bằng dấu hiệu trong mã của bạn.
Phiên thanh toán
subscribe() trả về một phiên thanh toán (ICreatedSubscription) — một đối tượng với paymentUrl mà người dùng phải mở để hoàn tất thanh toán đầu tiên. Chuyển hướng người dùng đến đó để hoàn tất thanh toán.
📋 Những điều bạn cần biết
- Tất cả các phương thức yêu cầu một người dùng đã được ủy quyền — gọi chúng sau khi người dùng đã đăng nhập qua mô-đun AuthProvider.
getAllSubscriptions()trả về tất cả các dấu hiệu có sẵn;getActiveSubscriptions()chỉ trả về các dấu hiệu mà người dùng hiện tại đã đăng ký.cancelSubscription()vàrecoverSubscriptions()trả vềtruekhi thành công.subscribe(),cancelSubscription(), vàrecoverSubscriptions()nhận một body có{ marker }.
📊 Bảng tham khảo nhanh
| Phương thức | Mô tả |
|---|---|
| subscribe() 🔐 | Tạo một đăng ký và nhận một phiên thanh toán |
| getAllSubscriptions() 🔐 | Lấy tất cả các dấu hiệu đăng ký có sẵn |
| getActiveSubscriptions() 🔐 | Lấy các dấu hiệu của các đăng ký đang hoạt động của người dùng |
| cancelSubscription() 🔐 | Hủy một đăng ký |
| recoverSubscriptions() 🔐 | Khôi phục một đăng ký qua Cổng thanh toán |
🔐 = Cần ủy quyền
❓ Câu hỏi thường gặp (FAQ)
Làm thế nào để tôi tạo một gói đăng ký?
Các gói đăng ký được cấu hình trong bảng điều khiển quản trị OneEntry và kết nối với một tài khoản thanh toán (ví dụ Stripe). SDK tham chiếu mỗi gói bằng dấu hiệu của nó.
subscribe() trả về cái gì?
Nó trả về một phiên thanh toán với paymentUrl. Chuyển hướng người dùng đến URL đó để hoàn tất thanh toán đầu tiên và kích hoạt đăng ký.
Sự khác biệt giữa hủy và khôi phục là gì?
cancelSubscription() dừng việc tính phí định kỳ cho một gói. recoverSubscriptions() khôi phục một đăng ký đã bị hủy trước đó thông qua Cổng thanh toán Stripe.
🎓 Thực hành tốt nhất
- Luôn tham chiếu các gói bằng dấu hiệu, không bao giờ bằng tên hiển thị.
- Xác thực người dùng trước khi gọi bất kỳ phương thức đăng ký nào.
- Sau
subscribe(), chuyển hướng người dùng đếnpaymentUrlvà xử lý URL trả về trong ứng dụng của bạn. - Sử dụng
getActiveSubscriptions()để kiểm soát các tính năng cao cấp trong giao diện người dùng của bạn.
🔗 Tài liệu liên quan
- Mô-đun AuthProvider - Cần thiết để ủy quyền người dùng
- Mô-đun Thanh toán - Tài khoản và phiên thanh toán
- Mô-đun Người dùng - Quản lý người dùng đăng ký